Package com.google.cloud.datalabeling.v1beta1

Class Example

  • All Implemented Interfaces:
    ExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Example
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • 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

      • hasImagePayload

        public boolean hasImagePayload()
         The image payload, a container of the image bytes/uri.
        .google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;
        Specified by:
        hasImagePayload in interface ExampleOrBuilder
        Returns:
        Whether the imagePayload field is set.

      • getImagePayload

        public ImagePayload getImagePayload()
         The image payload, a container of the image bytes/uri.
        .google.cloud.datalabeling.v1beta1.ImagePayload image_payload = 2;
        Specified by:
        getImagePayload in interface ExampleOrBuilder
        Returns:
        The imagePayload.

      • hasTextPayload

        public boolean hasTextPayload()
         The text payload, a container of the text content.
        .google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;
        Specified by:
        hasTextPayload in interface ExampleOrBuilder
        Returns:
        Whether the textPayload field is set.

      • getTextPayload

        public TextPayload getTextPayload()
         The text payload, a container of the text content.
        .google.cloud.datalabeling.v1beta1.TextPayload text_payload = 6;
        Specified by:
        getTextPayload in interface ExampleOrBuilder
        Returns:
        The textPayload.

      • hasVideoPayload

        public boolean hasVideoPayload()
         The video payload, a container of the video uri.
        .google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;
        Specified by:
        hasVideoPayload in interface ExampleOrBuilder
        Returns:
        Whether the videoPayload field is set.

      • getVideoPayload

        public VideoPayload getVideoPayload()
         The video payload, a container of the video uri.
        .google.cloud.datalabeling.v1beta1.VideoPayload video_payload = 7;
        Specified by:
        getVideoPayload in interface ExampleOrBuilder
        Returns:
        The videoPayload.

      • 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;
        Specified by:
        getName in interface ExampleOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • 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;
        Specified by:
        getAnnotationsList in interface ExampleOrBuilder

      • 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;
        Specified by:
        getAnnotationsOrBuilderList in interface ExampleOrBuilder

      • 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;
        Specified by:
        getAnnotationsCount in interface ExampleOrBuilder

      • getAnnotations

        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;
        Specified by:
        getAnnotations in interface ExampleOrBuilder

      • getAnnotationsOrBuilder

        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;
        Specified by:
        getAnnotationsOrBuilder in interface ExampleOrBuilder

      • 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 Example parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Example getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Example> parser()

      • getParserForType

        public com.google.protobuf.Parser<Example> 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 Example getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder