Class Annotation (0.171.0)

public final class Annotation extends GeneratedMessageV3 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 Fields

ANNOTATION_METADATA_FIELD_NUMBER

public static final int ANNOTATION_METADATA_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_SENTIMENT_FIELD_NUMBER

public static final int ANNOTATION_SENTIMENT_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_SOURCE_FIELD_NUMBER

public static final int ANNOTATION_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

ANNOTATION_VALUE_FIELD_NUMBER

public static final int ANNOTATION_VALUE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Annotation getDefaultInstance()
Returns
Type Description
Annotation

getDescriptor()

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

newBuilder()

public static Annotation.Builder newBuilder()
Returns
Type Description
Annotation.Builder

newBuilder(Annotation prototype)

public static Annotation.Builder newBuilder(Annotation prototype)
Parameter
Name Description
prototype Annotation
Returns
Type Description
Annotation.Builder

parseDelimitedFrom(InputStream input)

public static Annotation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Annotation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Annotation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Annotation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Annotation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Annotation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Annotation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Annotation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Annotation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Annotation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Annotation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Annotation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Annotation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Annotation> parser()
Returns
Type Description
Parser<Annotation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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

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.

getParserForType()

public Parser<Annotation> getParserForType()
Returns
Type Description
Parser<Annotation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Annotation.Builder newBuilderForType()
Returns
Type Description
Annotation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Annotation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Annotation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Annotation.Builder toBuilder()
Returns
Type Description
Annotation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException