Package com.google.cloud.datalabeling.v1beta1

Class AnnotatedDataset

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datalabeling.v1beta1.AnnotatedDataset
All Implemented Interfaces:
AnnotatedDatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AnnotatedDataset extends com.google.protobuf.GeneratedMessage implements AnnotatedDatasetOrBuilder
 AnnotatedDataset is a set holding annotations for data in a Dataset. Each
 labeling task will generate an AnnotatedDataset under the Dataset that the
 task is requested for.
Protobuf type google.cloud.datalabeling.v1beta1.AnnotatedDataset
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • ANNOTATION_SOURCE_FIELD_NUMBER

      public static final int ANNOTATION_SOURCE_FIELD_NUMBER
      See Also:

    • ANNOTATION_TYPE_FIELD_NUMBER

      public static final int ANNOTATION_TYPE_FIELD_NUMBER
      See Also:

    • EXAMPLE_COUNT_FIELD_NUMBER

      public static final int EXAMPLE_COUNT_FIELD_NUMBER
      See Also:

    • COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER

      public static final int COMPLETED_EXAMPLE_COUNT_FIELD_NUMBER
      See Also:

    • LABEL_STATS_FIELD_NUMBER

      public static final int LABEL_STATS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • BLOCKING_RESOURCES_FIELD_NUMBER

      public static final int BLOCKING_RESOURCES_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

    • getName

      public String getName()
       Output only. AnnotatedDataset resource name in format of:
 projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
 {annotated_dataset_id}
      string name = 1;
      Specified by:
      getName in interface AnnotatedDatasetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. AnnotatedDataset resource name in format of:
 projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
 {annotated_dataset_id}
      string name = 1;
      Specified by:
      getNameBytes in interface AnnotatedDatasetOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Output only. The display name of the AnnotatedDataset. It is specified in
 HumanAnnotationConfig when user starts a labeling task. Maximum of 64
 characters.
      string display_name = 2;
      Specified by:
      getDisplayName in interface AnnotatedDatasetOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Output only. The display name of the AnnotatedDataset. It is specified in
 HumanAnnotationConfig when user starts a labeling task. Maximum of 64
 characters.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface AnnotatedDatasetOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Output only. The description of the AnnotatedDataset. It is specified in
 HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
 characters.
      string description = 9;
      Specified by:
      getDescription in interface AnnotatedDatasetOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Output only. The description of the AnnotatedDataset. It is specified in
 HumanAnnotationConfig when user starts a labeling task. Maximum of 10000
 characters.
      string description = 9;
      Specified by:
      getDescriptionBytes in interface AnnotatedDatasetOrBuilder
      Returns:
      The bytes for description.

    • getAnnotationSourceValue

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

    • getAnnotationSource

      public AnnotationSource getAnnotationSource()
       Output only. Source of the annotation.
      .google.cloud.datalabeling.v1beta1.AnnotationSource annotation_source = 3;
      Specified by:
      getAnnotationSource in interface AnnotatedDatasetOrBuilder
      Returns:
      The annotationSource.

    • getAnnotationTypeValue

      public int getAnnotationTypeValue()
       Output only. Type of the annotation. It is specified when starting labeling
 task.
      .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
      Specified by:
      getAnnotationTypeValue in interface AnnotatedDatasetOrBuilder
      Returns:
      The enum numeric value on the wire for annotationType.

    • getAnnotationType

      public AnnotationType getAnnotationType()
       Output only. Type of the annotation. It is specified when starting labeling
 task.
      .google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 8;
      Specified by:
      getAnnotationType in interface AnnotatedDatasetOrBuilder
      Returns:
      The annotationType.

    • getExampleCount

      public long getExampleCount()
       Output only. Number of examples in the annotated dataset.
      int64 example_count = 4;
      Specified by:
      getExampleCount in interface AnnotatedDatasetOrBuilder
      Returns:
      The exampleCount.

    • getCompletedExampleCount

      public long getCompletedExampleCount()
       Output only. Number of examples that have annotation in the annotated
 dataset.
      int64 completed_example_count = 5;
      Specified by:
      getCompletedExampleCount in interface AnnotatedDatasetOrBuilder
      Returns:
      The completedExampleCount.

    • hasLabelStats

      public boolean hasLabelStats()
       Output only. Per label statistics.
      .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
      Specified by:
      hasLabelStats in interface AnnotatedDatasetOrBuilder
      Returns:
      Whether the labelStats field is set.

    • getLabelStats

      public LabelStats getLabelStats()
       Output only. Per label statistics.
      .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
      Specified by:
      getLabelStats in interface AnnotatedDatasetOrBuilder
      Returns:
      The labelStats.

    • getLabelStatsOrBuilder

      public LabelStatsOrBuilder getLabelStatsOrBuilder()
       Output only. Per label statistics.
      .google.cloud.datalabeling.v1beta1.LabelStats label_stats = 6;
      Specified by:
      getLabelStatsOrBuilder in interface AnnotatedDatasetOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Time the AnnotatedDataset was created.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      hasCreateTime in interface AnnotatedDatasetOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time the AnnotatedDataset was created.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      getCreateTime in interface AnnotatedDatasetOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time the AnnotatedDataset was created.
      .google.protobuf.Timestamp create_time = 7;
      Specified by:
      getCreateTimeOrBuilder in interface AnnotatedDatasetOrBuilder

    • hasMetadata

      public boolean hasMetadata()
       Output only. Additional information about AnnotatedDataset.
      .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
      Specified by:
      hasMetadata in interface AnnotatedDatasetOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public AnnotatedDatasetMetadata getMetadata()
       Output only. Additional information about AnnotatedDataset.
      .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
      Specified by:
      getMetadata in interface AnnotatedDatasetOrBuilder
      Returns:
      The metadata.

    • getMetadataOrBuilder

      public AnnotatedDatasetMetadataOrBuilder getMetadataOrBuilder()
       Output only. Additional information about AnnotatedDataset.
      .google.cloud.datalabeling.v1beta1.AnnotatedDatasetMetadata metadata = 10;
      Specified by:
      getMetadataOrBuilder in interface AnnotatedDatasetOrBuilder

    • getBlockingResourcesList

      public com.google.protobuf.ProtocolStringList getBlockingResourcesList()
       Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
      repeated string blocking_resources = 11;
      Specified by:
      getBlockingResourcesList in interface AnnotatedDatasetOrBuilder
      Returns:
      A list containing the blockingResources.

    • getBlockingResourcesCount

      public int getBlockingResourcesCount()
       Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
      repeated string blocking_resources = 11;
      Specified by:
      getBlockingResourcesCount in interface AnnotatedDatasetOrBuilder
      Returns:
      The count of blockingResources.

    • getBlockingResources

      public String getBlockingResources(int index)
       Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
      repeated string blocking_resources = 11;
      Specified by:
      getBlockingResources in interface AnnotatedDatasetOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The blockingResources at the given index.

    • getBlockingResourcesBytes

      public com.google.protobuf.ByteString getBlockingResourcesBytes(int index)
       Output only. The names of any related resources that are blocking changes
 to the annotated dataset.
      repeated string blocking_resources = 11;
      Specified by:
      getBlockingResourcesBytes in interface AnnotatedDatasetOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the blockingResources at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AnnotatedDataset parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AnnotatedDataset.Builder newBuilder()

    • newBuilder

      public static AnnotatedDataset.Builder newBuilder(AnnotatedDataset prototype)

    • toBuilder

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

    • newBuilderForType

      protected AnnotatedDataset.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AnnotatedDataset getDefaultInstance()

    • parser

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

    • getParserForType

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