Skip to main content

datasets

Overview

Namedatasets
TypeResource
Idgoogle.aiplatform.datasets

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the Dataset.
descriptionstringThe description of the Dataset.
createTimestringOutput only. Timestamp when this Dataset was created.
dataItemCountstringOutput only. The number of DataItems in this Dataset. Only apply for non-structured Dataset.
displayNamestringRequired. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpecobjectRepresents a customer-managed encryption key spec that can be applied to a top-level resource.
etagstringUsed to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labelsobjectThe 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 title.
metadataanyRequired. Additional information about the Dataset.
metadataArtifactstringOutput 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}.
metadataSchemaUristringRequired. 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/.
savedQueriesarrayAll 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.
updateTimestringOutput only. Timestamp when this Dataset was last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTdatasetsId, locationsId, projectsIdGets a Dataset.
listSELECTlocationsId, projectsIdLists Datasets in a Location.
createINSERTlocationsId, projectsIdCreates a Dataset.
deleteDELETEdatasetsId, locationsId, projectsIdDeletes a Dataset.
_listEXEClocationsId, projectsIdLists Datasets in a Location.
exportEXECdatasetsId, locationsId, projectsIdExports data from a Dataset.
importEXECdatasetsId, locationsId, projectsIdImports data into a Dataset.
patchEXECdatasetsId, locationsId, projectsIdUpdates a Dataset.
search_data_itemsEXECdatasetsId, locationsId, projectsIdSearches DataItems in a Dataset.