Struct google_api_proto::google::cloud::aiplatform::v1::ExportDataConfig

pub struct ExportDataConfig {
    pub annotations_filter: String,
    pub saved_query_id: String,
    pub annotation_schema_uri: String,
    pub export_use: i32,
    pub destination: Option<Destination>,
    pub split: Option<Split>,
}

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

Fields

annotations_filter: String

An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in [ListAnnotations][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].

saved_query_id: String

The ID of a SavedQuery (annotation set) under the Dataset specified by [dataset_id][] used for filtering Annotations for training.

Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter], the Annotations used for training are filtered by both [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id] and [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].

Only one of [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id] and [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri] should be specified as both of them represent the same thing: problem type.

annotation_schema_uri: String

The Cloud Storage URI that points to a YAML file describing the annotation schema. 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/annotation/, note that the chosen schema must be consistent with [metadata][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the Dataset specified by [dataset_id][].

Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter], the Annotations used for training are filtered by both [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter] and [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].

export_use: i32

Indicates the usage of the exported files.

destination: Option<Destination>

The destination of the output.

split: Option<Split>

The instructions how the export data should be split between the training, validation and test sets.

Implementations

impl ExportDataConfig

pub fn export_use(&self) -> ExportUse

Returns the enum value of export_use, or the default if the field is set to an invalid enum value.

pub fn set_export_use(&mut self, value: ExportUse)

Sets export_use to the provided enum value.

Trait Implementations

impl Clone for ExportDataConfig

fn clone(&self) -> ExportDataConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExportDataConfig

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

Formats the value using the given formatter.

impl Default for ExportDataConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for ExportDataConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ExportDataConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ExportDataConfig