Class Example.Builder (0.135.0)

public static final class Example.Builder extends GeneratedMessageV3.Builder<Example.Builder> implements ExampleOrBuilder

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

Protobuf type google.cloud.datalabeling.v1beta1.Example

Implements

ExampleOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllAnnotations(Iterable<? extends Annotation> values)

public Example.Builder addAllAnnotations(Iterable<? extends Annotation> values)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.datalabeling.v1beta1.Annotation>
Returns
TypeDescription
Example.Builder

addAnnotations(Annotation value)

public Example.Builder addAnnotations(Annotation value)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
valueAnnotation
Returns
TypeDescription
Example.Builder

addAnnotations(Annotation.Builder builderForValue)

public Example.Builder addAnnotations(Annotation.Builder builderForValue)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
builderForValueAnnotation.Builder
Returns
TypeDescription
Example.Builder

addAnnotations(int index, Annotation value)

public Example.Builder addAnnotations(int index, Annotation value)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameters
NameDescription
indexint
valueAnnotation
Returns
TypeDescription
Example.Builder

addAnnotations(int index, Annotation.Builder builderForValue)

public Example.Builder addAnnotations(int index, Annotation.Builder builderForValue)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameters
NameDescription
indexint
builderForValueAnnotation.Builder
Returns
TypeDescription
Example.Builder

addAnnotationsBuilder()

public Annotation.Builder addAnnotationsBuilder()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
Annotation.Builder

addAnnotationsBuilder(int index)

public Annotation.Builder addAnnotationsBuilder(int index)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Example.Builder
Overrides

build()

public Example build()
Returns
TypeDescription
Example

buildPartial()

public Example buildPartial()
Returns
TypeDescription
Example

clear()

public Example.Builder clear()
Returns
TypeDescription
Example.Builder
Overrides

clearAnnotations()

public Example.Builder clearAnnotations()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
Example.Builder

clearField(Descriptors.FieldDescriptor field)

public Example.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Example.Builder
Overrides

clearImagePayload()

public Example.Builder clearImagePayload()

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns
TypeDescription
Example.Builder

clearName()

public Example.Builder clearName()

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

string name = 1;

Returns
TypeDescription
Example.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Example.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Example.Builder
Overrides

clearPayload()

public Example.Builder clearPayload()
Returns
TypeDescription
Example.Builder

clearTextPayload()

public Example.Builder clearTextPayload()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns
TypeDescription
Example.Builder

clearVideoPayload()

public Example.Builder clearVideoPayload()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns
TypeDescription
Example.Builder

clone()

public Example.Builder clone()
Returns
TypeDescription
Example.Builder
Overrides

getAnnotations(int index)

public Annotation getAnnotations(int index)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation

getAnnotationsBuilder(int index)

public Annotation.Builder getAnnotationsBuilder(int index)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Annotation.Builder

getAnnotationsBuilderList()

public List<Annotation.Builder> getAnnotationsBuilderList()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
List<Builder>

getAnnotationsCount()

public int getAnnotationsCount()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
int

getAnnotationsList()

public List<Annotation> getAnnotationsList()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
List<Annotation>

getAnnotationsOrBuilder(int index)

public AnnotationOrBuilder getAnnotationsOrBuilder(int index)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
AnnotationOrBuilder

getAnnotationsOrBuilderList()

public List<? extends AnnotationOrBuilder> getAnnotationsOrBuilderList()

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Returns
TypeDescription
List<? extends com.google.cloud.datalabeling.v1beta1.AnnotationOrBuilder>

getDefaultInstanceForType()

public Example getDefaultInstanceForType()
Returns
TypeDescription
Example

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getImagePayload()

public ImagePayload getImagePayload()

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns
TypeDescription
ImagePayload

The imagePayload.

getImagePayloadBuilder()

public ImagePayload.Builder getImagePayloadBuilder()

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns
TypeDescription
ImagePayload.Builder

getImagePayloadOrBuilder()

public ImagePayloadOrBuilder getImagePayloadOrBuilder()

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns
TypeDescription
ImagePayloadOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getPayloadCase()

public Example.PayloadCase getPayloadCase()
Returns
TypeDescription
Example.PayloadCase

getTextPayload()

public TextPayload getTextPayload()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns
TypeDescription
TextPayload

The textPayload.

getTextPayloadBuilder()

public TextPayload.Builder getTextPayloadBuilder()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns
TypeDescription
TextPayload.Builder

getTextPayloadOrBuilder()

public TextPayloadOrBuilder getTextPayloadOrBuilder()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns
TypeDescription
TextPayloadOrBuilder

getVideoPayload()

public VideoPayload getVideoPayload()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns
TypeDescription
VideoPayload

The videoPayload.

getVideoPayloadBuilder()

public VideoPayload.Builder getVideoPayloadBuilder()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns
TypeDescription
VideoPayload.Builder

getVideoPayloadOrBuilder()

public VideoPayloadOrBuilder getVideoPayloadOrBuilder()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns
TypeDescription
VideoPayloadOrBuilder

hasImagePayload()

public boolean hasImagePayload()

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Returns
TypeDescription
boolean

Whether the imagePayload field is set.

hasTextPayload()

public boolean hasTextPayload()

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Returns
TypeDescription
boolean

Whether the textPayload field is set.

hasVideoPayload()

public boolean hasVideoPayload()

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Returns
TypeDescription
boolean

Whether the videoPayload field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Example other)

public Example.Builder mergeFrom(Example other)
Parameter
NameDescription
otherExample
Returns
TypeDescription
Example.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Example.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Example.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Example.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Example.Builder
Overrides

mergeImagePayload(ImagePayload value)

public Example.Builder mergeImagePayload(ImagePayload value)

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Parameter
NameDescription
valueImagePayload
Returns
TypeDescription
Example.Builder

mergeTextPayload(TextPayload value)

public Example.Builder mergeTextPayload(TextPayload value)

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Parameter
NameDescription
valueTextPayload
Returns
TypeDescription
Example.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Example.Builder
Overrides

mergeVideoPayload(VideoPayload value)

public Example.Builder mergeVideoPayload(VideoPayload value)

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Parameter
NameDescription
valueVideoPayload
Returns
TypeDescription
Example.Builder

removeAnnotations(int index)

public Example.Builder removeAnnotations(int index)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Example.Builder

setAnnotations(int index, Annotation value)

public Example.Builder setAnnotations(int index, Annotation value)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameters
NameDescription
indexint
valueAnnotation
Returns
TypeDescription
Example.Builder

setAnnotations(int index, Annotation.Builder builderForValue)

public Example.Builder setAnnotations(int index, Annotation.Builder builderForValue)

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

repeated .google.cloud.datalabeling.v1beta1.Annotation annotations = 5;

Parameters
NameDescription
indexint
builderForValueAnnotation.Builder
Returns
TypeDescription
Example.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Example.Builder
Overrides

setImagePayload(ImagePayload value)

public Example.Builder setImagePayload(ImagePayload value)

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Parameter
NameDescription
valueImagePayload
Returns
TypeDescription
Example.Builder

setImagePayload(ImagePayload.Builder builderForValue)

public Example.Builder setImagePayload(ImagePayload.Builder builderForValue)

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

.google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;

Parameter
NameDescription
builderForValueImagePayload.Builder
Returns
TypeDescription
Example.Builder

setName(String value)

public Example.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Example.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Example.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Example.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Example.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Example.Builder
Overrides

setTextPayload(TextPayload value)

public Example.Builder setTextPayload(TextPayload value)

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Parameter
NameDescription
valueTextPayload
Returns
TypeDescription
Example.Builder

setTextPayload(TextPayload.Builder builderForValue)

public Example.Builder setTextPayload(TextPayload.Builder builderForValue)

The text payload, a container of the text content.

.google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;

Parameter
NameDescription
builderForValueTextPayload.Builder
Returns
TypeDescription
Example.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Example.Builder
Overrides

setVideoPayload(VideoPayload value)

public Example.Builder setVideoPayload(VideoPayload value)

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Parameter
NameDescription
valueVideoPayload
Returns
TypeDescription
Example.Builder

setVideoPayload(VideoPayload.Builder builderForValue)

public Example.Builder setVideoPayload(VideoPayload.Builder builderForValue)

The video payload, a container of the video uri.

.google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;

Parameter
NameDescription
builderForValueVideoPayload.Builder
Returns
TypeDescription
Example.Builder