Package com.google.cloud.datalabeling.v1beta1

Class Dataset

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.datalabeling.v1beta1.Dataset
All Implemented Interfaces:
DatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Dataset extends com.google.protobuf.GeneratedMessage implements DatasetOrBuilder
 Dataset is the resource to hold your data. You can request multiple labeling
 tasks for a dataset while each one will generate an AnnotatedDataset.
Protobuf type google.cloud.datalabeling.v1beta1.Dataset
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Dataset.Builder
    Dataset is the resource to hold your data.

    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
    BLOCKING_RESOURCES_FIELD_NUMBER
     
    static final int
    CREATE_TIME_FIELD_NUMBER
     
    static final int
    DATA_ITEM_COUNT_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    INPUT_CONFIGS_FIELD_NUMBER
     
    static final int
    NAME_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)
     
    String
    getBlockingResources(int index)
    Output only.
    com.google.protobuf.ByteString
    getBlockingResourcesBytes(int index)
    Output only.
    int
    getBlockingResourcesCount()
    Output only.
    com.google.protobuf.ProtocolStringList
    getBlockingResourcesList()
    Output only.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    long
    getDataItemCount()
    Output only.
    static Dataset
    getDefaultInstance()
     
    Dataset
    getDefaultInstanceForType()
     
    String
    getDescription()
    Optional.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Optional.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Required.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Required.
    InputConfig
    getInputConfigs(int index)
    Output only.
    int
    getInputConfigsCount()
    Output only.
    List<InputConfig>
    getInputConfigsList()
    Output only.
    InputConfigOrBuilder
    getInputConfigsOrBuilder(int index)
    Output only.
    List<? extends InputConfigOrBuilder>
    getInputConfigsOrBuilderList()
    Output only.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    com.google.protobuf.Parser<Dataset>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasCreateTime()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Dataset.Builder
    newBuilder()
     
    static Dataset.Builder
    newBuilder(Dataset prototype)
     
    Dataset.Builder
    newBuilderForType()
     
    protected Dataset.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Dataset
    parseDelimitedFrom(InputStream input)
     
    static Dataset
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dataset
    parseFrom(byte[] data)
     
    static Dataset
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dataset
    parseFrom(com.google.protobuf.ByteString data)
     
    static Dataset
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dataset
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Dataset
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dataset
    parseFrom(InputStream input)
     
    static Dataset
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Dataset
    parseFrom(ByteBuffer data)
     
    static Dataset
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Dataset>
    parser()
     
    Dataset.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

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

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • INPUT_CONFIGS_FIELD_NUMBER

      public static final int INPUT_CONFIGS_FIELD_NUMBER
      See Also:

    • BLOCKING_RESOURCES_FIELD_NUMBER

      public static final int BLOCKING_RESOURCES_FIELD_NUMBER
      See Also:

    • DATA_ITEM_COUNT_FIELD_NUMBER

      public static final int DATA_ITEM_COUNT_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. Dataset resource name, format is:
 projects/{project_id}/datasets/{dataset_id}
      string name = 1;
      Specified by:
      getName in interface DatasetOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Dataset resource name, format is:
 projects/{project_id}/datasets/{dataset_id}
      string name = 1;
      Specified by:
      getNameBytes in interface DatasetOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The display name of the dataset. Maximum of 64 characters.
      string display_name = 2;
      Specified by:
      getDisplayName in interface DatasetOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The display name of the dataset. Maximum of 64 characters.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface DatasetOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Optional. User-provided description of the annotation specification set.
 The description can be up to 10000 characters long.
      string description = 3;
      Specified by:
      getDescription in interface DatasetOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. User-provided description of the annotation specification set.
 The description can be up to 10000 characters long.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface DatasetOrBuilder
      Returns:
      The bytes for description.

    • hasCreateTime

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

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Time the dataset is created.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      getCreateTime in interface DatasetOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time the dataset is created.
      .google.protobuf.Timestamp create_time = 4;
      Specified by:
      getCreateTimeOrBuilder in interface DatasetOrBuilder

    • getInputConfigsList

      public List<InputConfig> getInputConfigsList()
       Output only. This is populated with the original input configs
 where ImportData is called. It is available only after the clients
 import data to this dataset.
      repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;
      Specified by:
      getInputConfigsList in interface DatasetOrBuilder

    • getInputConfigsOrBuilderList

      public List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()
       Output only. This is populated with the original input configs
 where ImportData is called. It is available only after the clients
 import data to this dataset.
      repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;
      Specified by:
      getInputConfigsOrBuilderList in interface DatasetOrBuilder

    • getInputConfigsCount

      public int getInputConfigsCount()
       Output only. This is populated with the original input configs
 where ImportData is called. It is available only after the clients
 import data to this dataset.
      repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;
      Specified by:
      getInputConfigsCount in interface DatasetOrBuilder

    • getInputConfigs

      public InputConfig getInputConfigs(int index)
       Output only. This is populated with the original input configs
 where ImportData is called. It is available only after the clients
 import data to this dataset.
      repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;
      Specified by:
      getInputConfigs in interface DatasetOrBuilder

    • getInputConfigsOrBuilder

      public InputConfigOrBuilder getInputConfigsOrBuilder(int index)
       Output only. This is populated with the original input configs
 where ImportData is called. It is available only after the clients
 import data to this dataset.
      repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;
      Specified by:
      getInputConfigsOrBuilder in interface DatasetOrBuilder

    • getBlockingResourcesList

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

    • getBlockingResourcesCount

      public int getBlockingResourcesCount()
       Output only. The names of any related resources that are blocking changes
 to the dataset.
      repeated string blocking_resources = 6;
      Specified by:
      getBlockingResourcesCount in interface DatasetOrBuilder
      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 dataset.
      repeated string blocking_resources = 6;
      Specified by:
      getBlockingResources in interface DatasetOrBuilder
      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 dataset.
      repeated string blocking_resources = 6;
      Specified by:
      getBlockingResourcesBytes in interface DatasetOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the blockingResources at the given index.

    • getDataItemCount

      public long getDataItemCount()
       Output only. The number of data items in the dataset.
      int64 data_item_count = 7;
      Specified by:
      getDataItemCount in interface DatasetOrBuilder
      Returns:
      The dataItemCount.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Dataset.Builder newBuilder()

    • newBuilder

      public static Dataset.Builder newBuilder(Dataset prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Dataset getDefaultInstance()

    • parser

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

    • getParserForType

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