- 3.56.0 (latest)
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public interface FeatureViewOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)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.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBigQuerySource()
public abstract FeatureView.BigQuerySource getBigQuerySource()Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.BigQuerySource |
The bigQuerySource. |
getBigQuerySourceOrBuilder()
public abstract FeatureView.BigQuerySourceOrBuilder getBigQuerySourceOrBuilder()Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.BigQuerySourceOrBuilder |
|
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp when this FeatureView was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when this FeatureView was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getEtag()
public abstract String getEtag()Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes()Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getFeatureRegistrySource()
public abstract FeatureView.FeatureRegistrySource getFeatureRegistrySource()Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.FeatureRegistrySource |
The featureRegistrySource. |
getFeatureRegistrySourceOrBuilder()
public abstract FeatureView.FeatureRegistrySourceOrBuilder getFeatureRegistrySourceOrBuilder()Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.FeatureRegistrySourceOrBuilder |
|
getIndexConfig()
public abstract FeatureView.IndexConfig 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.
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.IndexConfig |
The indexConfig. |
getIndexConfigOrBuilder()
public abstract FeatureView.IndexConfigOrBuilder getIndexConfigOrBuilder()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.
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.IndexConfigOrBuilder |
|
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount()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.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap()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.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)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.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)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.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName() Identifier. Name of the FeatureView. Format:
projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. Name of the FeatureView. Format:
projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOptimizedConfig()
public abstract FeatureView.OptimizedConfig getOptimizedConfig()Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.OptimizedConfig |
The optimizedConfig. |
getOptimizedConfigOrBuilder()
public abstract FeatureView.OptimizedConfigOrBuilder getOptimizedConfigOrBuilder()Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.OptimizedConfigOrBuilder |
|
getSatisfiesPzi()
public abstract boolean getSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzi. |
getSatisfiesPzs()
public abstract boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
The satisfiesPzs. |
getServiceAccountEmail()
public abstract String 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.
string service_account_email = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountEmail. |
getServiceAccountEmailBytes()
public abstract ByteString getServiceAccountEmailBytes()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.
string service_account_email = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountEmail. |
getServiceAgentType()
public abstract FeatureView.ServiceAgentType 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.
.google.cloud.aiplatform.v1beta1.FeatureView.ServiceAgentType service_agent_type = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.ServiceAgentType |
The serviceAgentType. |
getServiceAgentTypeValue()
public abstract int getServiceAgentTypeValue() 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.
.google.cloud.aiplatform.v1beta1.FeatureView.ServiceAgentType service_agent_type = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for serviceAgentType. |
getSourceCase()
public abstract FeatureView.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
FeatureView.SourceCase |
|
getSyncConfig()
public abstract FeatureView.SyncConfig 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.
.google.cloud.aiplatform.v1beta1.FeatureView.SyncConfig sync_config = 7;
| Returns | |
|---|---|
| Type | Description |
FeatureView.SyncConfig |
The syncConfig. |
getSyncConfigOrBuilder()
public abstract FeatureView.SyncConfigOrBuilder getSyncConfigOrBuilder()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.
.google.cloud.aiplatform.v1beta1.FeatureView.SyncConfig sync_config = 7;
| Returns | |
|---|---|
| Type | Description |
FeatureView.SyncConfigOrBuilder |
|
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Timestamp when this FeatureView was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when this FeatureView was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getVectorSearchConfig() (deprecated)
public abstract FeatureView.VectorSearchConfig getVectorSearchConfig()Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See google/cloud/aiplatform/v1beta1/feature_view.proto;l=339
Optional. Deprecated: please use FeatureView.index_config instead.
.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig vector_search_config = 8 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.VectorSearchConfig |
The vectorSearchConfig. |
getVectorSearchConfigOrBuilder() (deprecated)
public abstract FeatureView.VectorSearchConfigOrBuilder getVectorSearchConfigOrBuilder()Optional. Deprecated: please use FeatureView.index_config instead.
.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig vector_search_config = 8 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.VectorSearchConfigOrBuilder |
|
getVertexRagSource()
public abstract FeatureView.VertexRagSource getVertexRagSource()Optional. The Vertex RAG Source that the FeatureView is linked to.
.google.cloud.aiplatform.v1beta1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.VertexRagSource |
The vertexRagSource. |
getVertexRagSourceOrBuilder()
public abstract FeatureView.VertexRagSourceOrBuilder getVertexRagSourceOrBuilder()Optional. The Vertex RAG Source that the FeatureView is linked to.
.google.cloud.aiplatform.v1beta1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureView.VertexRagSourceOrBuilder |
|
hasBigQuerySource()
public abstract boolean hasBigQuerySource()Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the bigQuerySource field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp when this FeatureView was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasFeatureRegistrySource()
public abstract boolean hasFeatureRegistrySource()Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the featureRegistrySource field is set. |
hasIndexConfig()
public abstract boolean hasIndexConfig()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.
.google.cloud.aiplatform.v1beta1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the indexConfig field is set. |
hasOptimizedConfig()
public abstract boolean hasOptimizedConfig()Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore.
.google.cloud.aiplatform.v1beta1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the optimizedConfig field is set. |
hasSyncConfig()
public abstract boolean hasSyncConfig()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.
.google.cloud.aiplatform.v1beta1.FeatureView.SyncConfig sync_config = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the syncConfig field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Timestamp when this FeatureView was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
hasVectorSearchConfig() (deprecated)
public abstract boolean hasVectorSearchConfig()Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See google/cloud/aiplatform/v1beta1/feature_view.proto;l=339
Optional. Deprecated: please use FeatureView.index_config instead.
.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig vector_search_config = 8 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vectorSearchConfig field is set. |
hasVertexRagSource()
public abstract boolean hasVertexRagSource()Optional. The Vertex RAG Source that the FeatureView is linked to.
.google.cloud.aiplatform.v1beta1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vertexRagSource field is set. |