Struct Dataset

#[non_exhaustive]
pub struct Dataset {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub metadata_schema_uri: String,
    pub metadata: Option<Value>,
    pub data_item_count: i64,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub etag: String,
    pub labels: HashMap<String, String>,
    pub saved_queries: Vec<SavedQuery>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub metadata_artifact: String,
    pub model_reference: String,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    /* private fields */
}

A collection of DataItems and Annotations on them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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

display_name: String

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: String

The description of the Dataset.

metadata_schema_uri: String

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: Option<Value>

Required. Additional information about the Dataset.

data_item_count: i64

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

create_time: Option<Timestamp>

Output only. Timestamp when this Dataset was created.

update_time: Option<Timestamp>

Output only. Timestamp when this Dataset was last updated.

etag: String

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

labels: HashMap<String, String>

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

saved_queries: Vec<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: Option<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: String

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

model_reference: String

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

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

Implementations

impl Dataset

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_metadata_schema_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of metadata_schema_uri.

pub fn set_metadata<T: Into<Option<Value>>>(self, v: T) -> Self

Sets the value of metadata.

pub fn set_data_item_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of data_item_count.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_saved_queries<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SavedQuery>,

Sets the value of saved_queries.

pub fn set_encryption_spec<T: Into<Option<EncryptionSpec>>>(self, v: T) -> Self

Sets the value of encryption_spec.

pub fn set_metadata_artifact<T: Into<String>>(self, v: T) -> Self

Sets the value of metadata_artifact.

pub fn set_model_reference<T: Into<String>>(self, v: T) -> Self

Sets the value of model_reference.

pub fn set_satisfies_pzs<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzs.

pub fn set_satisfies_pzi<T: Into<bool>>(self, v: T) -> Self

Sets the value of satisfies_pzi.

Trait Implementations

impl Clone for Dataset

fn clone(&self) -> Dataset

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dataset

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Dataset

fn default() -> Dataset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dataset

where Dataset: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Dataset

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Dataset

fn eq(&self, other: &Dataset) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Dataset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Dataset