Package com.google.cloud.aiplatform.v1

Interface DatasetOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Dataset, Dataset.Builder
    public interface DatasetOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

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

      • getNameBytes

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

      • getDisplayName

        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];
        Returns:
        The displayName.

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • getDescription

        String getDescription()
         The description of the Dataset.
        string description = 16;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         The description of the Dataset.
        string description = 16;
        Returns:
        The bytes for description.

      • getMetadataSchemaUri

        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];
        Returns:
        The metadataSchemaUri.

      • getMetadataSchemaUriBytes

        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];
        Returns:
        The bytes for metadataSchemaUri.

      • hasMetadata

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

      • getMetadata

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

      • getMetadataOrBuilder

        com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
         Required. Additional information about the Dataset.
        .google.protobuf.Value metadata = 8 [(.google.api.field_behavior) = REQUIRED];

      • getDataItemCount

        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];
        Returns:
        The dataItemCount.

      • hasCreateTime

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

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasUpdateTime

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

      • getUpdateTime

        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];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        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];

      • getEtag

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

      • getEtagBytes

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

      • getLabelsCount

        int getLabelsCount()
         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;

      • containsLabels

        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;

      • getLabelsMap

        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;

      • getLabelsOrDefault

        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;

      • getLabelsOrThrow

        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;

      • getSavedQueriesList

        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;

      • getSavedQueries

        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;

      • getSavedQueriesCount

        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;

      • getSavedQueriesOrBuilderList

        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;

      • getSavedQueriesOrBuilder

        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;

      • hasEncryptionSpec

        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;
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        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;
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        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;

      • getMetadataArtifact

        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];
        Returns:
        The metadataArtifact.

      • getMetadataArtifactBytes

        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];
        Returns:
        The bytes for metadataArtifact.