Struct FeatureView 

#[non_exhaustive]
pub struct FeatureView {

    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub etag: String,
    pub labels: HashMap<String, String>,
    pub sync_config: Option<SyncConfig>,
    pub index_config: Option<IndexConfig>,
    pub optimized_config: Option<OptimizedConfig>,
    pub service_agent_type: ServiceAgentType,
    pub service_account_email: String,
    pub satisfies_pzs: bool,
    pub satisfies_pzi: bool,
    pub bigtable_metadata: Option<BigtableMetadata>,
    pub source: Option<Source>,
    /* private fields */
}

Available on crate feature feature-online-store-admin-service only.

FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.

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

Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

create_time: Option<Timestamp>

Output only. Timestamp when this FeatureView was created.

update_time: Option<Timestamp>

Output only. Timestamp when this FeatureView was last updated.

etag: String

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

labels: HashMap<String, String>

Optional. The labels with user-defined metadata to organize your FeatureViews.

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.

See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded).“ System reserved label keys are prefixed with “aiplatform.googleapis.com/” and are immutable.

sync_config: Option<SyncConfig>

Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.

index_config: Option<IndexConfig>

Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.

optimized_config: Option<OptimizedConfig>

Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.

service_agent_type: ServiceAgentType

Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to SERVICE_AGENT_TYPE_FEATURE_VIEW. This will generate a separate service account to access the BigQuery source table.

service_account_email: String

Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store.

satisfies_pzs: bool

Output only. Reserved for future use.

satisfies_pzi: bool

Output only. Reserved for future use.

bigtable_metadata: Option<BigtableMetadata>

Metadata containing information about the Cloud Bigtable.

source: Option<Source>

Implementations

impl FeatureView

pub fn new() -> Self

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

Sets the value of name.

Example

let x = FeatureView::new().set_name("example");

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

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

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

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

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

Sets the value of etag.

Example

let x = FeatureView::new().set_etag("example");

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.

Example

let x = FeatureView::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<SyncConfig>,

Sets the value of sync_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::SyncConfig;
let x = FeatureView::new().set_sync_config(SyncConfig::default()/* use setters */);

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

where T: Into<SyncConfig>,

Sets or clears the value of sync_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::SyncConfig;
let x = FeatureView::new().set_or_clear_sync_config(Some(SyncConfig::default()/* use setters */));
let x = FeatureView::new().set_or_clear_sync_config(None::<SyncConfig>);

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

where T: Into<IndexConfig>,

Sets the value of index_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::IndexConfig;
let x = FeatureView::new().set_index_config(IndexConfig::default()/* use setters */);

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

where T: Into<IndexConfig>,

Sets or clears the value of index_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::IndexConfig;
let x = FeatureView::new().set_or_clear_index_config(Some(IndexConfig::default()/* use setters */));
let x = FeatureView::new().set_or_clear_index_config(None::<IndexConfig>);

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

where T: Into<OptimizedConfig>,

Sets the value of optimized_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::OptimizedConfig;
let x = FeatureView::new().set_optimized_config(OptimizedConfig::default()/* use setters */);

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

where T: Into<OptimizedConfig>,

Sets or clears the value of optimized_config.

Example

use google_cloud_aiplatform_v1::model::feature_view::OptimizedConfig;
let x = FeatureView::new().set_or_clear_optimized_config(Some(OptimizedConfig::default()/* use setters */));
let x = FeatureView::new().set_or_clear_optimized_config(None::<OptimizedConfig>);

pub fn set_service_agent_type<T: Into<ServiceAgentType>>(self, v: T) -> Self

Sets the value of service_agent_type.

Example

use google_cloud_aiplatform_v1::model::feature_view::ServiceAgentType;
let x0 = FeatureView::new().set_service_agent_type(ServiceAgentType::Project);
let x1 = FeatureView::new().set_service_agent_type(ServiceAgentType::FeatureView);

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

Sets the value of service_account_email.

Example

let x = FeatureView::new().set_service_account_email("example");

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

Sets the value of satisfies_pzs.

Example

let x = FeatureView::new().set_satisfies_pzs(true);

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

Sets the value of satisfies_pzi.

Example

let x = FeatureView::new().set_satisfies_pzi(true);

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

where T: Into<BigtableMetadata>,

Sets the value of bigtable_metadata.

Example

use google_cloud_aiplatform_v1::model::feature_view::BigtableMetadata;
let x = FeatureView::new().set_bigtable_metadata(BigtableMetadata::default()/* use setters */);

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

where T: Into<BigtableMetadata>,

Sets or clears the value of bigtable_metadata.

Example

use google_cloud_aiplatform_v1::model::feature_view::BigtableMetadata;
let x = FeatureView::new().set_or_clear_bigtable_metadata(Some(BigtableMetadata::default()/* use setters */));
let x = FeatureView::new().set_or_clear_bigtable_metadata(None::<BigtableMetadata>);

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::feature_view::BigQuerySource;
let x = FeatureView::new().set_source(Some(
    google_cloud_aiplatform_v1::model::feature_view::Source::BigQuerySource(BigQuerySource::default().into())));

pub fn big_query_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_big_query_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::feature_view::BigQuerySource;
let x = FeatureView::new().set_big_query_source(BigQuerySource::default()/* use setters */);
assert!(x.big_query_source().is_some());
assert!(x.feature_registry_source().is_none());
assert!(x.vertex_rag_source().is_none());

pub fn feature_registry_source(&self) -> Option<&Box<FeatureRegistrySource>>

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

pub fn set_feature_registry_source<T: Into<Box<FeatureRegistrySource>>>( self, v: T, ) -> Self

Sets the value of source to hold a FeatureRegistrySource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::feature_view::FeatureRegistrySource;
let x = FeatureView::new().set_feature_registry_source(FeatureRegistrySource::default()/* use setters */);
assert!(x.feature_registry_source().is_some());
assert!(x.big_query_source().is_none());
assert!(x.vertex_rag_source().is_none());

pub fn vertex_rag_source(&self) -> Option<&Box<VertexRagSource>>

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

pub fn set_vertex_rag_source<T: Into<Box<VertexRagSource>>>(self, v: T) -> Self

Sets the value of source to hold a VertexRagSource.

Note that all the setters affecting source are mutually exclusive.

Example

use google_cloud_aiplatform_v1::model::feature_view::VertexRagSource;
let x = FeatureView::new().set_vertex_rag_source(VertexRagSource::default()/* use setters */);
assert!(x.vertex_rag_source().is_some());
assert!(x.big_query_source().is_none());
assert!(x.feature_registry_source().is_none());

Trait Implementations

impl Clone for FeatureView

fn clone(&self) -> FeatureView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeatureView

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

Formats the value using the given formatter.

impl Default for FeatureView

fn default() -> FeatureView

Returns the “default value” for a type.

impl Message for FeatureView

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FeatureView

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