Class Annotation.Builder (0.163.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

Implements

AnnotationOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Annotation.Builder
Overrides

build()

public Annotation build()
Returns
Type Description
Annotation

buildPartial()

public Annotation buildPartial()
Returns
Type Description
Annotation

clear()

public Annotation.Builder clear()
Returns
Type Description
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
Type Description
Annotation.Builder

clearAnnotationSentiment()

public Annotation.Builder clearAnnotationSentiment()

Output only. Sentiment for this annotation.

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

Returns
Type Description
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
Type Description
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
Type Description
Annotation.Builder

clearField(Descriptors.FieldDescriptor field)

public Annotation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
Annotation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Annotation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Annotation.Builder
Overrides

clone()

public Annotation.Builder clone()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
AnnotationMetadataOrBuilder

getAnnotationSentiment()

public AnnotationSentiment getAnnotationSentiment()

Output only. Sentiment for this annotation.

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

Returns
Type Description
AnnotationSentiment

The annotationSentiment.

getAnnotationSentimentValue()

public int getAnnotationSentimentValue()

Output only. Sentiment for this annotation.

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

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

The annotationSource.

getAnnotationSourceValue()

public int getAnnotationSourceValue()

Output only. The source of the annotation.

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

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

getDefaultInstanceForType()

public Annotation getDefaultInstanceForType()
Returns
Type Description
Annotation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the annotationValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value AnnotationMetadata
Returns
Type Description
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
Name Description
value AnnotationValue
Returns
Type Description
Annotation.Builder

mergeFrom(Annotation other)

public Annotation.Builder mergeFrom(Annotation other)
Parameter
Name Description
other Annotation
Returns
Type Description
Annotation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Annotation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Annotation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Annotation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value AnnotationMetadata
Returns
Type Description
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
Name Description
builderForValue AnnotationMetadata.Builder
Returns
Type Description
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
Name Description
value AnnotationSentiment

The annotationSentiment to set.

Returns
Type Description
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
Name Description
value int

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

Returns
Type Description
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
Name Description
value AnnotationSource

The annotationSource to set.

Returns
Type Description
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
Name Description
value int

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

Returns
Type Description
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
Name Description
value AnnotationValue
Returns
Type Description
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
Name Description
builderForValue AnnotationValue.Builder
Returns
Type Description
Annotation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Annotation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The name to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Annotation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Annotation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Annotation.Builder
Overrides