Class Dataset (1.37.0)

  Dataset 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

A collection of DataItems and Annotations on them.

Attributes

Name

Description

name

str
Output only. The resource name of the Dataset.

display_name

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

description

str
The description of the Dataset.

metadata_schema_uri

str
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/.

metadata

google.protobuf.struct_pb2.Value
Required. Additional information about the Dataset.

data_item_count

int
Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.

create_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Dataset was created.

update_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Dataset was last updated.

etag

str
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels

MutableMapping[str, str]
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.v1beta1.Dataset.metadata_schema_uri] title.

saved_queries

MutableSequence[ google.cloud.aiplatform_v1beta1.types.SavedQuery 
]

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

encryption_spec

 google.cloud.aiplatform_v1beta1.types.EncryptionSpec

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.

metadata_artifact

str
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} .

Classes

LabelsEntry

  LabelsEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

The abstract base class for a message.

Parameters

Name

Description

kwargs

dict

Keys and values corresponding to the fields of the message.

mapping

Union[dict, .Message 
]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields

Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Methods

Dataset

  Dataset 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

A collection of DataItems and Annotations on them.