Class Example.Builder (0.123.3)

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Example.Builder

Implements

ExampleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
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

Name	Description
values	`Iterable<? extends com.google.cloud.datalabeling.v1beta1.Annotation>`

Returns

Type	Description
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

Name	Description
value	`Annotation`

Returns

Type	Description
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

Name	Description
builderForValue	`Annotation.Builder`

Returns

Type	Description
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

Name	Description
index	`int`
value	`Annotation`

Returns

Type	Description
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

Name	Description
index	`int`
builderForValue	`Annotation.Builder`

Returns

Type	Description
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

Type	Description
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

Name	Description
index	`int`

Returns

Type	Description
Annotation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Example build()

Returns

Type	Description
Example

buildPartial()

public Example buildPartial()

Returns

Type	Description
Example

clear()

public Example.Builder clear()

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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

Type	Description
Example.Builder

clearField(Descriptors.FieldDescriptor field)

public Example.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearImagePayload()

public Example.Builder clearImagePayload()

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

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

Returns

Type	Description
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

Type	Description
Example.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Example.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPayload()

public Example.Builder clearPayload()

Returns

Type	Description
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

Type	Description
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

Type	Description
Example.Builder

clone()

public Example.Builder clone()

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

Name	Description
index	`int`

Returns

Type	Description
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

Name	Description
index	`int`

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
index	`int`

Returns

Type	Description
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

Type	Description
List<? extends com.google.cloud.datalabeling.v1beta1.AnnotationOrBuilder>

getDefaultInstanceForType()

public Example getDefaultInstanceForType()

Returns

Type	Description
Example

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getImagePayload()

public ImagePayload getImagePayload()

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

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

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
ByteString	The bytes for name.

getPayloadCase()

public Example.PayloadCase getPayloadCase()

Returns

Type	Description
Example.PayloadCase

getTextPayload()

public TextPayload getTextPayload()

The text payload, a container of the text content.

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

Returns

Type	Description
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

Type	Description
TextPayload.Builder

getTextPayloadOrBuilder()

public TextPayloadOrBuilder getTextPayloadOrBuilder()

The text payload, a container of the text content.

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

Returns

Type	Description
TextPayloadOrBuilder

getVideoPayload()

public VideoPayload getVideoPayload()

The video payload, a container of the video uri.

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

Returns

Type	Description
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

Type	Description
VideoPayload.Builder

getVideoPayloadOrBuilder()

public VideoPayloadOrBuilder getVideoPayloadOrBuilder()

The video payload, a container of the video uri.

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

Returns

Type	Description
VideoPayloadOrBuilder

hasImagePayload()

public boolean hasImagePayload()

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

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

Returns

Type	Description
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

Type	Description
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

Type	Description
boolean	Whether the videoPayload field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Example other)

public Example.Builder mergeFrom(Example other)

Parameter

Name	Description
other	`Example`

Returns

Type	Description
Example.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Example.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Example.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Example.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Example.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Name	Description
value	`ImagePayload`

Returns

Type	Description
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

Name	Description
value	`TextPayload`

Returns

Type	Description
Example.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
value	`VideoPayload`

Returns

Type	Description
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

Name	Description
index	`int`

Returns

Type	Description
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

Name	Description
index	`int`
value	`Annotation`

Returns

Type	Description
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

Name	Description
index	`int`
builderForValue	`Annotation.Builder`

Returns

Type	Description
Example.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Example.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	`ImagePayload`

Returns

Type	Description
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

Name	Description
builderForValue	`ImagePayload.Builder`

Returns

Type	Description
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

Name	Description
value	`String` The name to set.

Returns

Type	Description
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

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
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

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Name	Description
value	`TextPayload`

Returns

Type	Description
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

Name	Description
builderForValue	`TextPayload.Builder`

Returns

Type	Description
Example.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Example.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Example.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
value	`VideoPayload`

Returns

Type	Description
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

Name	Description
builderForValue	`VideoPayload.Builder`

Returns

Type	Description
Example.Builder