Class Annotation

  • All Implemented Interfaces:
    AnnotationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Annotation
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Field Detail

      • ANNOTATION_SOURCE_FIELD_NUMBER

        public static final int ANNOTATION_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATION_VALUE_FIELD_NUMBER

        public static final int ANNOTATION_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATION_METADATA_FIELD_NUMBER

        public static final int ANNOTATION_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATION_SENTIMENT_FIELD_NUMBER

        public static final int ANNOTATION_SENTIMENT_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        getName in interface AnnotationOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface AnnotationOrBuilder
        Returns:
        The bytes for name.
      • getAnnotationSourceValue

        public int getAnnotationSourceValue()
         Output only. The source of the annotation.
         
        .google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;
        Specified by:
        getAnnotationSourceValue in interface AnnotationOrBuilder
        Returns:
        The enum numeric value on the wire for annotationSource.
      • getAnnotationSource

        public AnnotationSource getAnnotationSource()
         Output only. The source of the annotation.
         
        .google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 2;
        Specified by:
        getAnnotationSource in interface AnnotationOrBuilder
        Returns:
        The annotationSource.
      • 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;
        Specified by:
        hasAnnotationValue in interface AnnotationOrBuilder
        Returns:
        Whether the annotationValue field is set.
      • 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;
        Specified by:
        getAnnotationValue in interface AnnotationOrBuilder
        Returns:
        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;
        Specified by:
        getAnnotationValueOrBuilder in interface AnnotationOrBuilder
      • hasAnnotationMetadata

        public boolean hasAnnotationMetadata()
         Output only. Annotation metadata, including information like votes
         for labels.
         
        .google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;
        Specified by:
        hasAnnotationMetadata in interface AnnotationOrBuilder
        Returns:
        Whether the annotationMetadata field is set.
      • getAnnotationMetadata

        public AnnotationMetadata getAnnotationMetadata()
         Output only. Annotation metadata, including information like votes
         for labels.
         
        .google.cloud.datalabeling.v1beta1.AnnotationMetadata annotation_metadata = 4;
        Specified by:
        getAnnotationMetadata in interface AnnotationOrBuilder
        Returns:
        The annotationMetadata.
      • getAnnotationSentimentValue

        public int getAnnotationSentimentValue()
         Output only. Sentiment for this annotation.
         
        .google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;
        Specified by:
        getAnnotationSentimentValue in interface AnnotationOrBuilder
        Returns:
        The enum numeric value on the wire for annotationSentiment.
      • getAnnotationSentiment

        public AnnotationSentiment getAnnotationSentiment()
         Output only. Sentiment for this annotation.
         
        .google.cloud.datalabeling.v1beta1.AnnotationSentiment annotation_sentiment = 6;
        Specified by:
        getAnnotationSentiment in interface AnnotationOrBuilder
        Returns:
        The annotationSentiment.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Annotation parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Annotation parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Annotation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Annotation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Annotation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Annotation getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Annotation> parser()
      • getParserForType

        public com.google.protobuf.Parser<Annotation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Annotation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder