Package com.google.cloud.datalabeling.v1beta1

Class Example

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datalabeling.v1beta1.Example
All Implemented Interfaces:
ExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Example extends com.google.protobuf.GeneratedMessage 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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Example.Builder
    An Example is a piece of data and its annotation.
    static enum 
    Example.PayloadCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ANNOTATIONS_FIELD_NUMBER
     
    static final int
    IMAGE_PAYLOAD_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TEXT_PAYLOAD_FIELD_NUMBER
     
    static final int
    VIDEO_PAYLOAD_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Annotation
    getAnnotations(int index)
    Output only.
    int
    getAnnotationsCount()
    Output only.
    List<Annotation>
    getAnnotationsList()
    Output only.
    AnnotationOrBuilder
    getAnnotationsOrBuilder(int index)
    Output only.
    List<? extends AnnotationOrBuilder>
    getAnnotationsOrBuilderList()
    Output only.
    static Example
    getDefaultInstance()
     
    Example
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    ImagePayload
    getImagePayload()
    The image payload, a container of the image bytes/uri.
    ImagePayloadOrBuilder
    getImagePayloadOrBuilder()
    The image payload, a container of the image bytes/uri.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<Example>
    getParserForType()
     
    Example.PayloadCase
    getPayloadCase()
     
    int
    getSerializedSize()
     
    TextPayload
    getTextPayload()
    The text payload, a container of the text content.
    TextPayloadOrBuilder
    getTextPayloadOrBuilder()
    The text payload, a container of the text content.
    VideoPayload
    getVideoPayload()
    The video payload, a container of the video uri.
    VideoPayloadOrBuilder
    getVideoPayloadOrBuilder()
    The video payload, a container of the video uri.
    int
    hashCode()
     
    boolean
    hasImagePayload()
    The image payload, a container of the image bytes/uri.
    boolean
    hasTextPayload()
    The text payload, a container of the text content.
    boolean
    hasVideoPayload()
    The video payload, a container of the video uri.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Example.Builder
    newBuilder()
     
    static Example.Builder
    newBuilder(Example prototype)
     
    Example.Builder
    newBuilderForType()
     
    protected Example.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Example
    parseDelimitedFrom(InputStream input)
     
    static Example
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Example
    parseFrom(byte[] data)
     
    static Example
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Example
    parseFrom(com.google.protobuf.ByteString data)
     
    static Example
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Example
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Example
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Example
    parseFrom(InputStream input)
     
    static Example
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Example
    parseFrom(ByteBuffer data)
     
    static Example
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Example>
    parser()
     
    Example.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • IMAGE_PAYLOAD_FIELD_NUMBER

      public static final int IMAGE_PAYLOAD_FIELD_NUMBER
      See Also:

    • TEXT_PAYLOAD_FIELD_NUMBER

      public static final int TEXT_PAYLOAD_FIELD_NUMBER
      See Also:

    • VIDEO_PAYLOAD_FIELD_NUMBER

      public static final int VIDEO_PAYLOAD_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ANNOTATIONS_FIELD_NUMBER

      public static final int ANNOTATIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getPayloadCase

      public Example.PayloadCase getPayloadCase()
      Specified by:
      getPayloadCase in interface ExampleOrBuilder

    • 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.

    • getImagePayloadOrBuilder

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

    • 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.

    • getTextPayloadOrBuilder

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

    • 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.

    • getVideoPayloadOrBuilder

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

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Example parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Example parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Example.Builder newBuilder()

    • newBuilder

      public static Example.Builder newBuilder(Example prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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