Google Cloud Ai Platform V1 Client - Class FeatureView (1.35.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FeatureView.

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

Generated from protobuf message google.cloud.aiplatform.v1.FeatureView

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ big_query_source
FeatureView\BigQuerySource

Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

↳ feature_registry_source
FeatureView\FeatureRegistrySource

Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

↳ vertex_rag_source
FeatureView\VertexRagSource

Optional. The Vertex RAG Source that the FeatureView is linked to.

↳ name
string

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

↳ create_time
Google\Protobuf\Timestamp

Output only. Timestamp when this FeatureView was created.

↳ update_time
Google\Protobuf\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
array| Google\Protobuf\Internal\MapField

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
FeatureView\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
FeatureView\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
FeatureView\OptimizedConfig

Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.

↳ service_agent_type
int

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.

getBigQuerySource

Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Returns
Type
Description

hasBigQuerySource

setBigQuerySource

Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Parameter
Name
Description
Returns
Type
Description
$this

getFeatureRegistrySource

Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Returns
Type
Description

hasFeatureRegistrySource

setFeatureRegistrySource

Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Parameter
Name
Description
Returns
Type
Description
$this

getVertexRagSource

Optional. The Vertex RAG Source that the FeatureView is linked to.

Returns
Type
Description

hasVertexRagSource

setVertexRagSource

Optional. The Vertex RAG Source that the FeatureView is linked to.

Parameter
Name
Description
Returns
Type
Description
$this

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Timestamp when this FeatureView was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this FeatureView was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Timestamp when this FeatureView was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this FeatureView was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

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

Returns
Type
Description
string

setEtag

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLabels

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.

Returns
Type
Description

setLabels

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.

Parameter
Name
Description
Returns
Type
Description
$this

getSyncConfig

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.

Returns
Type
Description

hasSyncConfig

clearSyncConfig

setSyncConfig

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.

Parameter
Name
Description
Returns
Type
Description
$this

getIndexConfig

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.

Returns
Type
Description

hasIndexConfig

clearIndexConfig

setIndexConfig

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.

Parameter
Name
Description
Returns
Type
Description
$this

getOptimizedConfig

Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.

Returns
Type
Description

hasOptimizedConfig

clearOptimizedConfig

setOptimizedConfig

Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.

Parameter
Name
Description
Returns
Type
Description
$this

getServiceAgentType

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.

Returns
Type
Description
int

setServiceAgentType

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.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getServiceAccountEmail

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.

Returns
Type
Description
string

setServiceAccountEmail

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type
Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type
Description
bool

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSource

Returns
Type
Description
string
Create a Mobile Website
View Site in Mobile | Classic
Share by: