Package com.google.cloud.aiplatform.v1

Class Dataset

  • All Implemented Interfaces:
    DatasetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Dataset
extends com.google.protobuf.GeneratedMessageV3
implements DatasetOrBuilder
     A collection of DataItems and Annotations on them.
    Protobuf type google.cloud.aiplatform.v1.Dataset
    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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         Output only. The resource name of the Dataset.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface DatasetOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the Dataset.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface DatasetOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        public String getDisplayName()
         Required. The user-defined name of the Dataset.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface DatasetOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The user-defined name of the Dataset.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface DatasetOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         The description of the Dataset.
        string description = 16;
        Specified by:
        getDescription in interface DatasetOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the Dataset.
        string description = 16;
        Specified by:
        getDescriptionBytes in interface DatasetOrBuilder
        Returns:
        The bytes for description.

      • getMetadataSchemaUri

        public String getMetadataSchemaUri()
         Required. Points to a YAML file stored on Google Cloud Storage describing
 additional information about the Dataset. The schema is defined as an
 OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
 found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
        string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMetadataSchemaUri in interface DatasetOrBuilder
        Returns:
        The metadataSchemaUri.

      • getMetadataSchemaUriBytes

        public com.google.protobuf.ByteString getMetadataSchemaUriBytes()
         Required. Points to a YAML file stored on Google Cloud Storage describing
 additional information about the Dataset. The schema is defined as an
 OpenAPI 3.0.2 Schema Object. The schema files that can be used here are
 found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
        string metadata_schema_uri = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMetadataSchemaUriBytes in interface DatasetOrBuilder
        Returns:
        The bytes for metadataSchemaUri.

      • hasMetadata

        public boolean hasMetadata()
         Required. Additional information about the Dataset.
        .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasMetadata in interface DatasetOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public com.google.protobuf.Value getMetadata()
         Required. Additional information about the Dataset.
        .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMetadata in interface DatasetOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
         Required. Additional information about the Dataset.
        .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMetadataOrBuilder in interface DatasetOrBuilder

      • getDataItemCount

        public long getDataItemCount()
         Output only. The number of DataItems in this Dataset. Only apply for
 non-structured Dataset.
        int64 data_item_count = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDataItemCount in interface DatasetOrBuilder
        Returns:
        The dataItemCount.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this Dataset was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DatasetOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this Dataset was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DatasetOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this Dataset was created.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DatasetOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Timestamp when this Dataset was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface DatasetOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Timestamp when this Dataset was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface DatasetOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Timestamp when this Dataset was last updated.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface DatasetOrBuilder

      • getEtag

        public String getEtag()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 6;
        Specified by:
        getEtag in interface DatasetOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 6;
        Specified by:
        getEtagBytes in interface DatasetOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: DatasetOrBuilder
         The labels with user-defined metadata to organize your Datasets.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable. Following system labels exist for each Dataset:

 * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
   value is the
   [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
   title.
        map<string, string> labels = 7;
        Specified by:
        getLabelsCount in interface DatasetOrBuilder

      • containsLabels

        public boolean containsLabels​(String key)
         The labels with user-defined metadata to organize your Datasets.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable. Following system labels exist for each Dataset:

 * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
   value is the
   [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
   title.
        map<string, string> labels = 7;
        Specified by:
        containsLabels in interface DatasetOrBuilder

      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         The labels with user-defined metadata to organize your Datasets.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable. Following system labels exist for each Dataset:

 * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
   value is the
   [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
   title.
        map<string, string> labels = 7;
        Specified by:
        getLabelsMap in interface DatasetOrBuilder

      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                 String defaultValue)
         The labels with user-defined metadata to organize your Datasets.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable. Following system labels exist for each Dataset:

 * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
   value is the
   [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
   title.
        map<string, string> labels = 7;
        Specified by:
        getLabelsOrDefault in interface DatasetOrBuilder

      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         The labels with user-defined metadata to organize your Datasets.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.
 No more than 64 user labels can be associated with one Dataset (System
 labels are excluded).

 See https://goo.gl/xmQnxf for more information and examples of labels.
 System reserved label keys are prefixed with "aiplatform.googleapis.com/"
 and are immutable. Following system labels exist for each Dataset:

 * "aiplatform.googleapis.com/dataset_metadata_schema": output only, its
   value is the
   [metadata_schema's][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri]
   title.
        map<string, string> labels = 7;
        Specified by:
        getLabelsOrThrow in interface DatasetOrBuilder

      • getSavedQueriesList

        public List<SavedQuery> getSavedQueriesList()
         All SavedQueries belong to the Dataset will be returned in List/Get
 Dataset response. The annotation_specs field
 will not be populated except for UI cases which will only use
 [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
 In CreateDataset request, a SavedQuery is created together if
 this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
 The SavedQuery should not contain any AnnotationSpec.
        repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;
        Specified by:
        getSavedQueriesList in interface DatasetOrBuilder

      • getSavedQueriesOrBuilderList

        public List<? extends SavedQueryOrBuilder> getSavedQueriesOrBuilderList()
         All SavedQueries belong to the Dataset will be returned in List/Get
 Dataset response. The annotation_specs field
 will not be populated except for UI cases which will only use
 [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
 In CreateDataset request, a SavedQuery is created together if
 this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
 The SavedQuery should not contain any AnnotationSpec.
        repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;
        Specified by:
        getSavedQueriesOrBuilderList in interface DatasetOrBuilder

      • getSavedQueriesCount

        public int getSavedQueriesCount()
         All SavedQueries belong to the Dataset will be returned in List/Get
 Dataset response. The annotation_specs field
 will not be populated except for UI cases which will only use
 [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
 In CreateDataset request, a SavedQuery is created together if
 this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
 The SavedQuery should not contain any AnnotationSpec.
        repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;
        Specified by:
        getSavedQueriesCount in interface DatasetOrBuilder

      • getSavedQueries

        public SavedQuery getSavedQueries​(int index)
         All SavedQueries belong to the Dataset will be returned in List/Get
 Dataset response. The annotation_specs field
 will not be populated except for UI cases which will only use
 [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
 In CreateDataset request, a SavedQuery is created together if
 this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
 The SavedQuery should not contain any AnnotationSpec.
        repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;
        Specified by:
        getSavedQueries in interface DatasetOrBuilder

      • getSavedQueriesOrBuilder

        public SavedQueryOrBuilder getSavedQueriesOrBuilder​(int index)
         All SavedQueries belong to the Dataset will be returned in List/Get
 Dataset response. The annotation_specs field
 will not be populated except for UI cases which will only use
 [annotation_spec_count][google.cloud.aiplatform.v1.SavedQuery.annotation_spec_count].
 In CreateDataset request, a SavedQuery is created together if
 this field is set, up to one SavedQuery can be set in CreateDatasetRequest.
 The SavedQuery should not contain any AnnotationSpec.
        repeated .google.cloud.aiplatform.v1.SavedQuery saved_queries = 9;
        Specified by:
        getSavedQueriesOrBuilder in interface DatasetOrBuilder

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Customer-managed encryption key spec for a Dataset. If set, this Dataset
 and all sub-resources of this Dataset will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
        Specified by:
        hasEncryptionSpec in interface DatasetOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Customer-managed encryption key spec for a Dataset. If set, this Dataset
 and all sub-resources of this Dataset will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
        Specified by:
        getEncryptionSpec in interface DatasetOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Customer-managed encryption key spec for a Dataset. If set, this Dataset
 and all sub-resources of this Dataset will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 11;
        Specified by:
        getEncryptionSpecOrBuilder in interface DatasetOrBuilder

      • getMetadataArtifact

        public String getMetadataArtifact()
         Output only. The resource name of the Artifact that was created in
 MetadataStore when creating the Dataset. The Artifact resource name pattern
 is
 `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
        string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadataArtifact in interface DatasetOrBuilder
        Returns:
        The metadataArtifact.

      • getMetadataArtifactBytes

        public com.google.protobuf.ByteString getMetadataArtifactBytes()
         Output only. The resource name of the Artifact that was created in
 MetadataStore when creating the Dataset. The Artifact resource name pattern
 is
 `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
        string metadata_artifact = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetadataArtifactBytes in interface DatasetOrBuilder
        Returns:
        The bytes for metadataArtifact.

      • 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 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​(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

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

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

      • getDefaultInstanceForType

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