Struct ExportDataConfig

#[non_exhaustive]
pub struct ExportDataConfig {
    pub annotations_filter: String,
    pub saved_query_id: String,
    pub annotation_schema_uri: String,
    pub export_use: ExportUse,
    pub destination: Option<Destination>,
    pub split: Option<Split>,
    /* private fields */
}

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

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.

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.

saved_query_id: String

The ID of a SavedQuery (annotation set) under the Dataset specified by ExportDataRequest.name 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, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and 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 of the Dataset specified by ExportDataRequest.name.

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, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

export_use: ExportUse

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 new() -> Self

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

Sets the value of annotations_filter.

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

Sets the value of saved_query_id.

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

Sets the value of annotation_schema_uri.

pub fn set_export_use<T: Into<ExportUse>>(self, v: T) -> Self

Sets the value of export_use.

pub fn set_destination<T: Into<Option<Destination>>>(self, v: T) -> Self

Sets the value of destination.

Note that all the setters affecting destination are mutually exclusive.

pub fn gcs_destination(&self) -> Option<&Box<GcsDestination>>

The value of destination if it holds a GcsDestination, None if the field is not set or holds a different branch.

pub fn set_gcs_destination<T: Into<Box<GcsDestination>>>(self, v: T) -> Self

Sets the value of destination to hold a GcsDestination.

Note that all the setters affecting destination are mutually exclusive.

pub fn set_split<T: Into<Option<Split>>>(self, v: T) -> Self

Sets the value of split.

Note that all the setters affecting split are mutually exclusive.

pub fn fraction_split(&self) -> Option<&Box<ExportFractionSplit>>

The value of split if it holds a FractionSplit, None if the field is not set or holds a different branch.

pub fn set_fraction_split<T: Into<Box<ExportFractionSplit>>>(self, v: T) -> Self

Sets the value of split to hold a FractionSplit.

Note that all the setters affecting split are mutually exclusive.

pub fn filter_split(&self) -> Option<&Box<ExportFilterSplit>>

The value of split if it holds a FilterSplit, None if the field is not set or holds a different branch.

pub fn set_filter_split<T: Into<Box<ExportFilterSplit>>>(self, v: T) -> Self

Sets the value of split to hold a FilterSplit.

Note that all the setters affecting split are mutually exclusive.

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() -> ExportDataConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExportDataConfig

where ExportDataConfig: 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 ExportDataConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ExportDataConfig

fn eq(&self, other: &ExportDataConfig) -> 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 ExportDataConfig

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 ExportDataConfig