Google Cloud Datalabeling V1beta1 Client - Class Example (0.7.2)

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

An Example is a piece of data and its annotation. For example, an image with label "house".

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

Namespace

Google \ Cloud \ DataLabeling \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ image_payload ImagePayload

The image payload, a container of the image bytes/uri.

↳ text_payload TextPayload

The text payload, a container of the text content.

↳ video_payload VideoPayload

The video payload, a container of the video uri.

↳ name string

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

↳ annotations array<Annotation>

Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations.

getImagePayload

The image payload, a container of the image bytes/uri.

Returns
Type Description
ImagePayload|null

hasImagePayload

setImagePayload

The image payload, a container of the image bytes/uri.

Parameter
Name Description
var ImagePayload
Returns
Type Description
$this

getTextPayload

The text payload, a container of the text content.

Returns
Type Description
TextPayload|null

hasTextPayload

setTextPayload

The text payload, a container of the text content.

Parameter
Name Description
var TextPayload
Returns
Type Description
$this

getVideoPayload

The video payload, a container of the video uri.

Returns
Type Description
VideoPayload|null

hasVideoPayload

setVideoPayload

The video payload, a container of the video uri.

Parameter
Name Description
var VideoPayload
Returns
Type Description
$this

getName

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

Returns
Type Description
string

setName

Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getAnnotations

Output only. Annotations for the piece of data in Example.

One piece of data can have multiple annotations.

Returns
Type Description
Google\Protobuf\RepeatedField<Annotation>

setAnnotations

Output only. Annotations for the piece of data in Example.

One piece of data can have multiple annotations.

Parameter
Name Description
var array<Annotation>
Returns
Type Description
$this

getPayload

Returns
Type Description
string