Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class GetExampleRequest.
Request message for GetExample
Generated from protobuf messagegoogle.cloud.datalabeling.v1beta1.GetExampleRequest
Namespace
Google \ Cloud \ DataLabeling \ V1beta1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}
↳ filter
string
Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
getName
Required. Name of example, format:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}/examples/{example_id}
Returns
Type
Description
string
setName
Required. Name of example, format:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}/examples/{example_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. An expression for filtering Examples. Filter by
annotation_spec.display_name is supported. Format
"annotation_spec.display_name = {display_name}"
Returns
Type
Description
string
setFilter
Optional. An expression for filtering Examples. Filter by
annotation_spec.display_name is supported. Format
"annotation_spec.display_name = {display_name}"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameters
Name
Description
name
string
Required. Name of example, format:
projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
{annotated_dataset_id}/examples/{example_id}
Please seeDataLabelingServiceClient::exampleName()for help formatting this field.
filter
string
Optional. An expression for filtering Examples. Filter by
annotation_spec.display_name is supported. Format
"annotation_spec.display_name = {display_name}"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Datalabeling V1beta1 Client - Class GetExampleRequest (0.6.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.3 (latest)](/php/docs/reference/cloud-datalabeling/latest/V1beta1.GetExampleRequest)\n- [0.6.2](/php/docs/reference/cloud-datalabeling/0.6.2/V1beta1.GetExampleRequest)\n- [0.5.7](/php/docs/reference/cloud-datalabeling/0.5.7/V1beta1.GetExampleRequest)\n- [0.4.2](/php/docs/reference/cloud-datalabeling/0.4.2/V1beta1.GetExampleRequest)\n- [0.3.1](/php/docs/reference/cloud-datalabeling/0.3.1/V1beta1.GetExampleRequest)\n- [0.2.0](/php/docs/reference/cloud-datalabeling/0.2.0/V1beta1.GetExampleRequest)\n- [0.1.14](/php/docs/reference/cloud-datalabeling/0.1.14/V1beta1.GetExampleRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class GetExampleRequest.\n\nRequest message for GetExample\n\nGenerated from protobuf message `google.cloud.datalabeling.v1beta1.GetExampleRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataLabeling \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Name of example, format:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/\n{annotated_dataset_id}/examples/{example_id}\n\n### setName\n\nRequired. Name of example, format:\nprojects/{project_id}/datasets/{dataset_id}/annotatedDatasets/\n{annotated_dataset_id}/examples/{example_id}\n\n### getFilter\n\nOptional. An expression for filtering Examples. Filter by\nannotation_spec.display_name is supported. Format\n\"annotation_spec.display_name = {display_name}\"\n\n### setFilter\n\nOptional. An expression for filtering Examples. Filter by\nannotation_spec.display_name is supported. Format\n\"annotation_spec.display_name = {display_name}\"\n\n### static::build"]]
