public final class FeatureView extends GeneratedMessageV3 implements FeatureViewOrBuilder
FeatureView is representation of values that the FeatureOnlineStore will
serve based on its syncConfig.
Protobuf type google.cloud.aiplatform.v1beta1.FeatureView
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BIG_QUERY_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FEATURE_REGISTRY_SOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int INDEX_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERVICE_ACCOUNT_EMAIL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SERVICE_AGENT_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SYNC_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VECTOR_SEARCH_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FeatureView getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FeatureView.Builder newBuilder()
public static FeatureView.Builder newBuilder(FeatureView prototype)
public static FeatureView parseDelimitedFrom(InputStream input)
public static FeatureView parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FeatureView parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FeatureView parseFrom(ByteString data)
public static FeatureView parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FeatureView parseFrom(CodedInputStream input)
public static FeatureView parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView parseFrom(InputStream input)
public static FeatureView parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FeatureView parseFrom(ByteBuffer data)
public static FeatureView parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FeatureView> parser()
Methods
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
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
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];
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this FeatureView was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FeatureView getDefaultInstanceForType()
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.
|
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.
|
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];
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];
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];
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];
public Map<String,String> getLabels()
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 |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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 |
|
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.
|
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.
|
public Parser<FeatureView> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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.
|
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];
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.
|
public FeatureView.SourceCase getSourceCase()
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;
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;
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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this FeatureView was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FeatureView.VectorSearchConfig getVectorSearchConfig()
Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See
google/cloud/aiplatform/v1beta1/feature_view.proto;l=304
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];
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];
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
public boolean hasVectorSearchConfig()
Deprecated. google.cloud.aiplatform.v1beta1.FeatureView.vector_search_config is deprecated. See
google/cloud/aiplatform/v1beta1/feature_view.proto;l=304
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public FeatureView.Builder newBuilderForType()
protected FeatureView.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FeatureView.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
