Cloud AI Platform v1 API - Class Dataset (3.11.0) 

public sealed class Dataset : IMessage<Dataset>, IEquatable<Dataset>, IDeepCloneable<Dataset>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class Dataset.

A collection of DataItems and Annotations on them.

Inheritance

object > Dataset

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Dataset()

public Dataset()

Dataset(Dataset)

public Dataset(Dataset other)
Parameter
Name Description
other Dataset

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this Dataset was created.

Property Value
Type Description
Timestamp

DataItemCount

public long DataItemCount { get; set; }

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

Property Value
Type Description
long

DatasetName

public DatasetName DatasetName { get; set; }

DatasetName-typed view over the Name resource name property.

Property Value
Type Description
DatasetName

Description

public string Description { get; set; }

The description of the Dataset.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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.

Property Value
Type Description
EncryptionSpec

Etag

public string Etag { get; set; }

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

Property Value
Type Description
string

Labels

public MapField<string, string> Labels { get; }

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.
Property Value
Type Description
MapFieldstringstring

Metadata

public Value Metadata { get; set; }

Required. Additional information about the Dataset.

Property Value
Type Description
Value

MetadataArtifact

public string MetadataArtifact { get; set; }

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

Property Value
Type Description
string

MetadataSchemaUri

public string MetadataSchemaUri { get; set; }

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

Property Value
Type Description
string

ModelReference

public string ModelReference { get; set; }

Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.

Property Value
Type Description
string

Name

public string Name { get; set; }

Output only. Identifier. The resource name of the Dataset.

Property Value
Type Description
string

SatisfiesPzi

public bool SatisfiesPzi { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

Output only. Reserved for future use.

Property Value
Type Description
bool

SavedQueries

public RepeatedField<SavedQuery> SavedQueries { get; }

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.

Property Value
Type Description
RepeatedFieldSavedQuery

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when this Dataset was last updated.

Property Value
Type Description
Timestamp