Class FeatureView.Builder (3.52.0)

public static final class FeatureView.Builder extends GeneratedMessageV3.Builder<FeatureView.Builder> implements FeatureViewOrBuilder

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

Protobuf type google.cloud.aiplatform.v1beta1.FeatureView

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FeatureView.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FeatureView.Builder
Overrides

build()

public FeatureView build()
Returns
Type Description
FeatureView

buildPartial()

public FeatureView buildPartial()
Returns
Type Description
FeatureView

clear()

public FeatureView.Builder clear()
Returns
Type Description
FeatureView.Builder
Overrides

clearBigQuerySource()

public FeatureView.Builder clearBigQuerySource()

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.Builder

clearCreateTime()

public FeatureView.Builder clearCreateTime()

Output only. Timestamp when this FeatureView was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FeatureView.Builder

clearEtag()

public FeatureView.Builder clearEtag()

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
FeatureView.Builder

This builder for chaining.

clearFeatureRegistrySource()

public FeatureView.Builder clearFeatureRegistrySource()

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.Builder

clearField(Descriptors.FieldDescriptor field)

public FeatureView.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FeatureView.Builder
Overrides

clearIndexConfig()

public FeatureView.Builder clearIndexConfig()

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.Builder

clearLabels()

public FeatureView.Builder clearLabels()
Returns
Type Description
FeatureView.Builder

clearName()

public FeatureView.Builder clearName()

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
FeatureView.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FeatureView.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FeatureView.Builder
Overrides

clearSatisfiesPzi()

public FeatureView.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FeatureView.Builder

This builder for chaining.

clearSatisfiesPzs()

public FeatureView.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FeatureView.Builder

This builder for chaining.

clearServiceAccountEmail()

public FeatureView.Builder clearServiceAccountEmail()

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
FeatureView.Builder

This builder for chaining.

clearServiceAgentType()

public FeatureView.Builder clearServiceAgentType()

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.Builder

This builder for chaining.

clearSource()

public FeatureView.Builder clearSource()
Returns
Type Description
FeatureView.Builder

clearSyncConfig()

public FeatureView.Builder clearSyncConfig()

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.Builder

clearUpdateTime()

public FeatureView.Builder clearUpdateTime()

Output only. Timestamp when this FeatureView was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FeatureView.Builder

clearVectorSearchConfig() (deprecated)

public FeatureView.Builder clearVectorSearchConfig()

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.Builder

clearVertexRagSource()

public FeatureView.Builder clearVertexRagSource()

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.Builder

clone()

public FeatureView.Builder clone()
Returns
Type Description
FeatureView.Builder
Overrides

containsLabels(String key)

public 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 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.

getBigQuerySourceBuilder()

public FeatureView.BigQuerySource.Builder getBigQuerySourceBuilder()

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.Builder

getBigQuerySourceOrBuilder()

public 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this FeatureView was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public FeatureView getDefaultInstanceForType()
Returns
Type Description
FeatureView

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public 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 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 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.

getFeatureRegistrySourceBuilder()

public FeatureView.FeatureRegistrySource.Builder getFeatureRegistrySourceBuilder()

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.Builder

getFeatureRegistrySourceOrBuilder()

public 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 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.

getIndexConfigBuilder()

public FeatureView.IndexConfig.Builder getIndexConfigBuilder()

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.Builder

getIndexConfigOrBuilder()

public 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public 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 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 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 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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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 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.

getSatisfiesPzi()

public 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 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 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 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 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 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 FeatureView.SourceCase getSourceCase()
Returns
Type Description
FeatureView.SourceCase

getSyncConfig()

public 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.

getSyncConfigBuilder()

public FeatureView.SyncConfig.Builder getSyncConfigBuilder()

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.Builder

getSyncConfigOrBuilder()

public 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Timestamp when this FeatureView was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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 FeatureView.VectorSearchConfig getVectorSearchConfig()

Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See google/cloud/aiplatform/v1beta1/feature_view.proto;l=327

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.

getVectorSearchConfigBuilder() (deprecated)

public FeatureView.VectorSearchConfig.Builder getVectorSearchConfigBuilder()

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.Builder

getVectorSearchConfigOrBuilder() (deprecated)

public 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 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.

getVertexRagSourceBuilder()

public FeatureView.VertexRagSource.Builder getVertexRagSourceBuilder()

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.Builder

getVertexRagSourceOrBuilder()

public 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 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 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 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 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.

hasSyncConfig()

public 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 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 boolean hasVectorSearchConfig()

Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See google/cloud/aiplatform/v1beta1/feature_view.proto;l=327

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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigQuerySource(FeatureView.BigQuerySource value)

public FeatureView.Builder mergeBigQuerySource(FeatureView.BigQuerySource value)

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];

Parameter
Name Description
value FeatureView.BigQuerySource
Returns
Type Description
FeatureView.Builder

mergeCreateTime(Timestamp value)

public FeatureView.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this FeatureView was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
FeatureView.Builder

mergeFeatureRegistrySource(FeatureView.FeatureRegistrySource value)

public FeatureView.Builder mergeFeatureRegistrySource(FeatureView.FeatureRegistrySource value)

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];

Parameter
Name Description
value FeatureView.FeatureRegistrySource
Returns
Type Description
FeatureView.Builder

mergeFrom(FeatureView other)

public FeatureView.Builder mergeFrom(FeatureView other)
Parameter
Name Description
other FeatureView
Returns
Type Description
FeatureView.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FeatureView.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureView.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FeatureView.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FeatureView.Builder
Overrides

mergeIndexConfig(FeatureView.IndexConfig value)

public FeatureView.Builder mergeIndexConfig(FeatureView.IndexConfig value)

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];

Parameter
Name Description
value FeatureView.IndexConfig
Returns
Type Description
FeatureView.Builder

mergeSyncConfig(FeatureView.SyncConfig value)

public FeatureView.Builder mergeSyncConfig(FeatureView.SyncConfig value)

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;

Parameter
Name Description
value FeatureView.SyncConfig
Returns
Type Description
FeatureView.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FeatureView.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FeatureView.Builder
Overrides

mergeUpdateTime(Timestamp value)

public FeatureView.Builder mergeUpdateTime(Timestamp value)

Output only. Timestamp when this FeatureView was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
FeatureView.Builder

mergeVectorSearchConfig(FeatureView.VectorSearchConfig value) (deprecated)

public FeatureView.Builder mergeVectorSearchConfig(FeatureView.VectorSearchConfig value)

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];

Parameter
Name Description
value FeatureView.VectorSearchConfig
Returns
Type Description
FeatureView.Builder

mergeVertexRagSource(FeatureView.VertexRagSource value)

public FeatureView.Builder mergeVertexRagSource(FeatureView.VertexRagSource value)

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];

Parameter
Name Description
value FeatureView.VertexRagSource
Returns
Type Description
FeatureView.Builder

putAllLabels(Map<String,String> values)

public FeatureView.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
FeatureView.Builder

putLabels(String key, String value)

public FeatureView.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
FeatureView.Builder

removeLabels(String key)

public FeatureView.Builder removeLabels(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
FeatureView.Builder

setBigQuerySource(FeatureView.BigQuerySource value)

public FeatureView.Builder setBigQuerySource(FeatureView.BigQuerySource value)

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];

Parameter
Name Description
value FeatureView.BigQuerySource
Returns
Type Description
FeatureView.Builder

setBigQuerySource(FeatureView.BigQuerySource.Builder builderForValue)

public FeatureView.Builder setBigQuerySource(FeatureView.BigQuerySource.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FeatureView.BigQuerySource.Builder
Returns
Type Description
FeatureView.Builder

setCreateTime(Timestamp value)

public FeatureView.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this FeatureView was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
FeatureView.Builder

setCreateTime(Timestamp.Builder builderForValue)

public FeatureView.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this FeatureView was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FeatureView.Builder

setEtag(String value)

public FeatureView.Builder setEtag(String value)

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];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public FeatureView.Builder setEtagBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setFeatureRegistrySource(FeatureView.FeatureRegistrySource value)

public FeatureView.Builder setFeatureRegistrySource(FeatureView.FeatureRegistrySource value)

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];

Parameter
Name Description
value FeatureView.FeatureRegistrySource
Returns
Type Description
FeatureView.Builder

setFeatureRegistrySource(FeatureView.FeatureRegistrySource.Builder builderForValue)

public FeatureView.Builder setFeatureRegistrySource(FeatureView.FeatureRegistrySource.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FeatureView.FeatureRegistrySource.Builder
Returns
Type Description
FeatureView.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FeatureView.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FeatureView.Builder
Overrides

setIndexConfig(FeatureView.IndexConfig value)

public FeatureView.Builder setIndexConfig(FeatureView.IndexConfig value)

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];

Parameter
Name Description
value FeatureView.IndexConfig
Returns
Type Description
FeatureView.Builder

setIndexConfig(FeatureView.IndexConfig.Builder builderForValue)

public FeatureView.Builder setIndexConfig(FeatureView.IndexConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FeatureView.IndexConfig.Builder
Returns
Type Description
FeatureView.Builder

setName(String value)

public FeatureView.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FeatureView.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FeatureView.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FeatureView.Builder
Overrides

setSatisfiesPzi(boolean value)

public FeatureView.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public FeatureView.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setServiceAccountEmail(String value)

public FeatureView.Builder setServiceAccountEmail(String value)

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];

Parameter
Name Description
value String

The serviceAccountEmail to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setServiceAccountEmailBytes(ByteString value)

public FeatureView.Builder setServiceAccountEmailBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for serviceAccountEmail to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setServiceAgentType(FeatureView.ServiceAgentType value)

public FeatureView.Builder setServiceAgentType(FeatureView.ServiceAgentType value)

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];

Parameter
Name Description
value FeatureView.ServiceAgentType

The serviceAgentType to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setServiceAgentTypeValue(int value)

public FeatureView.Builder setServiceAgentTypeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for serviceAgentType to set.

Returns
Type Description
FeatureView.Builder

This builder for chaining.

setSyncConfig(FeatureView.SyncConfig value)

public FeatureView.Builder setSyncConfig(FeatureView.SyncConfig value)

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;

Parameter
Name Description
value FeatureView.SyncConfig
Returns
Type Description
FeatureView.Builder

setSyncConfig(FeatureView.SyncConfig.Builder builderForValue)

public FeatureView.Builder setSyncConfig(FeatureView.SyncConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FeatureView.SyncConfig.Builder
Returns
Type Description
FeatureView.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final FeatureView.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FeatureView.Builder
Overrides

setUpdateTime(Timestamp value)

public FeatureView.Builder setUpdateTime(Timestamp value)

Output only. Timestamp when this FeatureView was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
FeatureView.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public FeatureView.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this FeatureView was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FeatureView.Builder

setVectorSearchConfig(FeatureView.VectorSearchConfig value) (deprecated)

public FeatureView.Builder setVectorSearchConfig(FeatureView.VectorSearchConfig value)

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];

Parameter
Name Description
value FeatureView.VectorSearchConfig
Returns
Type Description
FeatureView.Builder

setVectorSearchConfig(FeatureView.VectorSearchConfig.Builder builderForValue) (deprecated)

public FeatureView.Builder setVectorSearchConfig(FeatureView.VectorSearchConfig.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FeatureView.VectorSearchConfig.Builder
Returns
Type Description
FeatureView.Builder

setVertexRagSource(FeatureView.VertexRagSource value)

public FeatureView.Builder setVertexRagSource(FeatureView.VertexRagSource value)

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];

Parameter
Name Description
value FeatureView.VertexRagSource
Returns
Type Description
FeatureView.Builder

setVertexRagSource(FeatureView.VertexRagSource.Builder builderForValue)

public FeatureView.Builder setVertexRagSource(FeatureView.VertexRagSource.Builder builderForValue)

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];

Parameter
Name Description
builderForValue FeatureView.VertexRagSource.Builder
Returns
Type Description
FeatureView.Builder