Google Cloud Datalabeling V1beta1 Client - Class GetExampleRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class GetExampleRequest.

Request message for GetExample

Generated from protobuf message google.cloud.datalabeling.v1beta1.GetExampleRequest

Methods

build

Parameters
NameDescription
name string

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id} Please see {@see \Google\Cloud\DataLabeling\V1beta1\DataLabelingServiceClient::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}"

Returns
TypeDescription
Google\Cloud\DataLabeling\V1beta1\GetExampleRequest

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

Returns
TypeDescription
string

setFilter

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

Parameter
NameDescription
var string
Returns
TypeDescription
$this