Google Cloud Datalabeling V1beta1 Client - Class GetExampleRequest (0.5.4)

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

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 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
Type Description
Google\Cloud\DataLabeling\V1beta1\GetExampleRequest