Struct BatchReadFeatureValuesRequest 

#[non_exhaustive]
pub struct BatchReadFeatureValuesRequest {
    pub featurestore: String,
    pub destination: Option<FeatureValueDestination>,
    pub pass_through_fields: Vec<PassThroughField>,
    pub entity_type_specs: Vec<EntityTypeSpec>,
    pub start_time: Option<Timestamp>,
    pub read_option: Option<ReadOption>,
    /* private fields */
}

Available on crate feature featurestore-service only.

Request message for FeaturestoreService.BatchReadFeatureValues.

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.

featurestore: String

Required. The resource name of the Featurestore from which to query Feature values. Format: projects/{project}/locations/{location}/featurestores/{featurestore}

destination: Option<FeatureValueDestination>

Required. Specifies output location and format.

pass_through_fields: Vec<PassThroughField>

When not empty, the specified fields in the *_read_instances source will be joined as-is in the output, in addition to those fields from the Featurestore Entity.

For BigQuery source, the type of the pass-through values will be automatically inferred. For CSV source, the pass-through values will be passed as opaque bytes.

entity_type_specs: Vec<EntityTypeSpec>

Required. Specifies EntityType grouping Features to read values of and settings.

start_time: Option<Timestamp>

Optional. Excludes Feature values with feature generation timestamp before this timestamp. If not set, retrieve oldest values kept in Feature Store. Timestamp, if present, must not have higher than millisecond precision.

read_option: Option<ReadOption>

Implementations

impl BatchReadFeatureValuesRequest

pub fn new() -> Self

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

Sets the value of featurestore.

Example

let x = BatchReadFeatureValuesRequest::new().set_featurestore("example");

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

where T: Into<FeatureValueDestination>,

Sets the value of destination.

Example

use google_cloud_aiplatform_v1::model::FeatureValueDestination;
let x = BatchReadFeatureValuesRequest::new().set_destination(FeatureValueDestination::default()/* use setters */);

pub fn set_or_clear_destination<T>(self, v: Option<T>) -> Self

where T: Into<FeatureValueDestination>,

Sets or clears the value of destination.

Example

use google_cloud_aiplatform_v1::model::FeatureValueDestination;
let x = BatchReadFeatureValuesRequest::new().set_or_clear_destination(Some(FeatureValueDestination::default()/* use setters */));
let x = BatchReadFeatureValuesRequest::new().set_or_clear_destination(None::<FeatureValueDestination>);

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

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

Sets the value of pass_through_fields.

Example

use google_cloud_aiplatform_v1::model::batch_read_feature_values_request::PassThroughField;
let x = BatchReadFeatureValuesRequest::new()
    .set_pass_through_fields([
        PassThroughField::default()/* use setters */,
        PassThroughField::default()/* use (different) setters */,
    ]);

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

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

Sets the value of entity_type_specs.

Example

use google_cloud_aiplatform_v1::model::batch_read_feature_values_request::EntityTypeSpec;
let x = BatchReadFeatureValuesRequest::new()
    .set_entity_type_specs([
        EntityTypeSpec::default()/* use setters */,
        EntityTypeSpec::default()/* use (different) setters */,
    ]);

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

use wkt::Timestamp;
let x = BatchReadFeatureValuesRequest::new().set_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = BatchReadFeatureValuesRequest::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = BatchReadFeatureValuesRequest::new().set_or_clear_start_time(None::<Timestamp>);

pub fn set_read_option<T: Into<Option<ReadOption>>>(self, v: T) -> Self

Sets the value of read_option.

Note that all the setters affecting read_option are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::CsvSource;
let x = BatchReadFeatureValuesRequest::new().set_read_option(Some(
    google_cloud_aiplatform_v1::model::batch_read_feature_values_request::ReadOption::CsvReadInstances(CsvSource::default().into())));

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

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

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

Sets the value of read_option to hold a CsvReadInstances.

Note that all the setters affecting read_option are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::CsvSource;
let x = BatchReadFeatureValuesRequest::new().set_csv_read_instances(CsvSource::default()/* use setters */);
assert!(x.csv_read_instances().is_some());
assert!(x.bigquery_read_instances().is_none());

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

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

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

Sets the value of read_option to hold a BigqueryReadInstances.

Note that all the setters affecting read_option are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::BigQuerySource;
let x = BatchReadFeatureValuesRequest::new().set_bigquery_read_instances(BigQuerySource::default()/* use setters */);
assert!(x.bigquery_read_instances().is_some());
assert!(x.csv_read_instances().is_none());

Trait Implementations

impl Clone for BatchReadFeatureValuesRequest

fn clone(&self) -> BatchReadFeatureValuesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchReadFeatureValuesRequest

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

Formats the value using the given formatter.

impl Default for BatchReadFeatureValuesRequest

fn default() -> BatchReadFeatureValuesRequest

Returns the “default value” for a type.

impl Message for BatchReadFeatureValuesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BatchReadFeatureValuesRequest

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