Struct ImportFeatureValuesRequest 

#[non_exhaustive]
pub struct ImportFeatureValuesRequest {
    pub entity_type: String,
    pub entity_id_field: String,
    pub feature_specs: Vec<FeatureSpec>,
    pub disable_online_serving: bool,
    pub worker_count: i32,
    pub disable_ingestion_analysis: bool,
    pub source: Option<Source>,
    pub feature_time_source: Option<FeatureTimeSource>,
    /* private fields */
}

Available on crate feature featurestore-service only.

Request message for FeaturestoreService.ImportFeatureValues.

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.

entity_type: String

Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}

entity_id_field: String

Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.

feature_specs: Vec<FeatureSpec>

Required. Specifications defining which Feature values to import from the entity. The request fails if no feature_specs are provided, and having multiple feature_specs for one Feature is not allowed.

disable_online_serving: bool

If set, data will not be imported for online serving. This is typically used for backfilling, where Feature generation timestamps are not in the timestamp range needed for online serving.

worker_count: i32

Specifies the number of workers that are used to write data to the Featurestore. Consider the online serving capacity that you require to achieve the desired import throughput without interfering with online serving. The value must be positive, and less than or equal to 100. If not set, defaults to using 1 worker. The low count ensures minimal impact on online serving performance.

disable_ingestion_analysis: bool

If true, API doesn’t start ingestion analysis pipeline.

source: Option<Source>

Details about the source data, including the location of the storage and the format.

feature_time_source: Option<FeatureTimeSource>

Source of Feature timestamp for all Feature values of each entity. Timestamps must be millisecond-aligned.

Implementations

impl ImportFeatureValuesRequest

pub fn new() -> Self

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

Sets the value of entity_type.

Example

let x = ImportFeatureValuesRequest::new().set_entity_type("example");

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

Sets the value of entity_id_field.

Example

let x = ImportFeatureValuesRequest::new().set_entity_id_field("example");

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

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

Sets the value of feature_specs.

Example

use google_cloud_aiplatform_v1::model::import_feature_values_request::FeatureSpec;
let x = ImportFeatureValuesRequest::new()
    .set_feature_specs([
        FeatureSpec::default()/* use setters */,
        FeatureSpec::default()/* use (different) setters */,
    ]);

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

Sets the value of disable_online_serving.

Example

let x = ImportFeatureValuesRequest::new().set_disable_online_serving(true);

pub fn set_worker_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of worker_count.

Example

let x = ImportFeatureValuesRequest::new().set_worker_count(42);

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

Sets the value of disable_ingestion_analysis.

Example

let x = ImportFeatureValuesRequest::new().set_disable_ingestion_analysis(true);

pub fn set_source<T: Into<Option<Source>>>(self, v: T) -> Self

Sets the value of source.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::AvroSource;
let x = ImportFeatureValuesRequest::new().set_source(Some(
    google_cloud_aiplatform_v1::model::import_feature_values_request::Source::AvroSource(AvroSource::default().into())));

pub fn avro_source(&self) -> Option<&Box<AvroSource>>

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

pub fn set_avro_source<T: Into<Box<AvroSource>>>(self, v: T) -> Self

Sets the value of source to hold a AvroSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::AvroSource;
let x = ImportFeatureValuesRequest::new().set_avro_source(AvroSource::default()/* use setters */);
assert!(x.avro_source().is_some());
assert!(x.bigquery_source().is_none());
assert!(x.csv_source().is_none());

pub fn bigquery_source(&self) -> Option<&Box<BigQuerySource>>

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

pub fn set_bigquery_source<T: Into<Box<BigQuerySource>>>(self, v: T) -> Self

Sets the value of source to hold a BigquerySource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::BigQuerySource;
let x = ImportFeatureValuesRequest::new().set_bigquery_source(BigQuerySource::default()/* use setters */);
assert!(x.bigquery_source().is_some());
assert!(x.avro_source().is_none());
assert!(x.csv_source().is_none());

pub fn csv_source(&self) -> Option<&Box<CsvSource>>

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

pub fn set_csv_source<T: Into<Box<CsvSource>>>(self, v: T) -> Self

Sets the value of source to hold a CsvSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::CsvSource;
let x = ImportFeatureValuesRequest::new().set_csv_source(CsvSource::default()/* use setters */);
assert!(x.csv_source().is_some());
assert!(x.avro_source().is_none());
assert!(x.bigquery_source().is_none());

pub fn set_feature_time_source<T: Into<Option<FeatureTimeSource>>>( self, v: T, ) -> Self

Sets the value of feature_time_source.

Note that all the setters affecting feature_time_source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::import_feature_values_request::FeatureTimeSource;
let x = ImportFeatureValuesRequest::new().set_feature_time_source(Some(FeatureTimeSource::FeatureTimeField("example".to_string())));

pub fn feature_time_field(&self) -> Option<&String>

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

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

Sets the value of feature_time_source to hold a FeatureTimeField.

Note that all the setters affecting feature_time_source are mutually exclusive.

Example

let x = ImportFeatureValuesRequest::new().set_feature_time_field("example");
assert!(x.feature_time_field().is_some());
assert!(x.feature_time().is_none());

pub fn feature_time(&self) -> Option<&Box<Timestamp>>

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

pub fn set_feature_time<T: Into<Box<Timestamp>>>(self, v: T) -> Self

Sets the value of feature_time_source to hold a FeatureTime.

Note that all the setters affecting feature_time_source are mutually exclusive.

Example

use wkt::Timestamp;
let x = ImportFeatureValuesRequest::new().set_feature_time(Timestamp::default()/* use setters */);
assert!(x.feature_time().is_some());
assert!(x.feature_time_field().is_none());

Trait Implementations

impl Clone for ImportFeatureValuesRequest

fn clone(&self) -> ImportFeatureValuesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImportFeatureValuesRequest

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

Formats the value using the given formatter.

impl Default for ImportFeatureValuesRequest

fn default() -> ImportFeatureValuesRequest

Returns the “default value” for a type.

impl Message for ImportFeatureValuesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ImportFeatureValuesRequest

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