Class Annotation.Builder (0.161.0) 

public static final class Annotation.Builder extends GeneratedMessageV3.Builder<Annotation.Builder> implements AnnotationOrBuilder

Annotation for Example. Each example may have one or more annotations. For example in image classification problem, each image might have one or more labels. We call labels binded with this image an Annotation.

Protobuf type google.cloud.datalabeling.v1beta1.Annotation

Inheritance

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

Implements

AnnotationOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Annotation build()
Returns
TypeDescription
Annotation

buildPartial()

public Annotation buildPartial()
Returns
TypeDescription
Annotation

clear()

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

clearAnnotationMetadata()

public Annotation.Builder clearAnnotationMetadata()

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Returns
TypeDescription
Annotation.Builder

clearAnnotationSentiment()

public Annotation.Builder clearAnnotationSentiment()

Output only. Sentiment for this annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

clearAnnotationSource()

public Annotation.Builder clearAnnotationSource()

Output only. The source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

clearAnnotationValue()

public Annotation.Builder clearAnnotationValue()

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Returns
TypeDescription
Annotation.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearName()

public Annotation.Builder clearName()

Output only. Unique name of this annotation, format is:

projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}

string name = 1;

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getAnnotationMetadata()

public AnnotationMetadata getAnnotationMetadata()

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Returns
TypeDescription
AnnotationMetadata

The annotationMetadata.

getAnnotationMetadataBuilder()

public AnnotationMetadata.Builder getAnnotationMetadataBuilder()

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Returns
TypeDescription
AnnotationMetadata.Builder

getAnnotationMetadataOrBuilder()

public AnnotationMetadataOrBuilder getAnnotationMetadataOrBuilder()

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Returns
TypeDescription
AnnotationMetadataOrBuilder

getAnnotationSentiment()

public AnnotationSentiment getAnnotationSentiment()

Output only. Sentiment for this annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;

Returns
TypeDescription
AnnotationSentiment

The annotationSentiment.

getAnnotationSentimentValue()

public int getAnnotationSentimentValue()

Output only. Sentiment for this annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for annotationSentiment.

getAnnotationSource()

public AnnotationSource getAnnotationSource()

Output only. The source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;

Returns
TypeDescription
AnnotationSource

The annotationSource.

getAnnotationSourceValue()

public int getAnnotationSourceValue()

Output only. The source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for annotationSource.

getAnnotationValue()

public AnnotationValue getAnnotationValue()

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Returns
TypeDescription
AnnotationValue

The annotationValue.

getAnnotationValueBuilder()

public AnnotationValue.Builder getAnnotationValueBuilder()

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Returns
TypeDescription
AnnotationValue.Builder

getAnnotationValueOrBuilder()

public AnnotationValueOrBuilder getAnnotationValueOrBuilder()

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Returns
TypeDescription
AnnotationValueOrBuilder

getDefaultInstanceForType()

public Annotation getDefaultInstanceForType()
Returns
TypeDescription
Annotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public String getName()

Output only. Unique name of this annotation, format is:

projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Unique name of this annotation, format is:

projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

hasAnnotationMetadata()

public boolean hasAnnotationMetadata()

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Returns
TypeDescription
boolean

Whether the annotationMetadata field is set.

hasAnnotationValue()

public boolean hasAnnotationValue()

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Returns
TypeDescription
boolean

Whether the annotationValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAnnotationMetadata(AnnotationMetadata value)

public Annotation.Builder mergeAnnotationMetadata(AnnotationMetadata value)

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Parameter
NameDescription
valueAnnotationMetadata
Returns
TypeDescription
Annotation.Builder

mergeAnnotationValue(AnnotationValue value)

public Annotation.Builder mergeAnnotationValue(AnnotationValue value)

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Parameter
NameDescription
valueAnnotationValue
Returns
TypeDescription
Annotation.Builder

mergeFrom(Annotation other)

public Annotation.Builder mergeFrom(Annotation other)
Parameter
NameDescription
otherAnnotation
Returns
TypeDescription
Annotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAnnotationMetadata(AnnotationMetadata value)

public Annotation.Builder setAnnotationMetadata(AnnotationMetadata value)

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Parameter
NameDescription
valueAnnotationMetadata
Returns
TypeDescription
Annotation.Builder

setAnnotationMetadata(AnnotationMetadata.Builder builderForValue)

public Annotation.Builder setAnnotationMetadata(AnnotationMetadata.Builder builderForValue)

Output only. Annotation metadata, including information like votes for labels.

.google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;

Parameter
NameDescription
builderForValueAnnotationMetadata.Builder
Returns
TypeDescription
Annotation.Builder

setAnnotationSentiment(AnnotationSentiment value)

public Annotation.Builder setAnnotationSentiment(AnnotationSentiment value)

Output only. Sentiment for this annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;

Parameter
NameDescription
valueAnnotationSentiment

The annotationSentiment to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setAnnotationSentimentValue(int value)

public Annotation.Builder setAnnotationSentimentValue(int value)

Output only. Sentiment for this annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for annotationSentiment to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setAnnotationSource(AnnotationSource value)

public Annotation.Builder setAnnotationSource(AnnotationSource value)

Output only. The source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;

Parameter
NameDescription
valueAnnotationSource

The annotationSource to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setAnnotationSourceValue(int value)

public Annotation.Builder setAnnotationSourceValue(int value)

Output only. The source of the annotation.

.google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;

Parameter
NameDescription
valueint

The enum numeric value on the wire for annotationSource to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setAnnotationValue(AnnotationValue value)

public Annotation.Builder setAnnotationValue(AnnotationValue value)

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Parameter
NameDescription
valueAnnotationValue
Returns
TypeDescription
Annotation.Builder

setAnnotationValue(AnnotationValue.Builder builderForValue)

public Annotation.Builder setAnnotationValue(AnnotationValue.Builder builderForValue)

Output only. This is the actual annotation value, e.g classification, bounding box values are stored here.

.google.cloud.datalabeling.v1beta1.AnnotationValue annotation_value = 3;

Parameter
NameDescription
builderForValueAnnotationValue.Builder
Returns
TypeDescription
Annotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Annotation.Builder setName(String value)

Output only. Unique name of this annotation, format is:

projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Annotation.Builder setNameBytes(ByteString value)

Output only. Unique name of this annotation, format is:

projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset}/examples/{example_id}/annotations/{annotation_id}

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Annotation.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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