Package com.google.cloud.aiplatform.v1

Interface FeatureViewOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FeatureView, FeatureView.Builder
@Generated public interface FeatureViewOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasBigQuerySource

      boolean hasBigQuerySource()
       Optional. Configures how data is supposed to be extracted from a BigQuery
 source to be loaded onto the FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the bigQuerySource field is set.

    • getBigQuerySource

      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.v1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bigQuerySource.

    • getBigQuerySourceOrBuilder

      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.v1.FeatureView.BigQuerySource big_query_source = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasFeatureRegistrySource

      boolean hasFeatureRegistrySource()
       Optional. Configures the features from a Feature Registry source that
 need to be loaded onto the FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the featureRegistrySource field is set.

    • getFeatureRegistrySource

      FeatureView.FeatureRegistrySource getFeatureRegistrySource()
       Optional. Configures the features from a Feature Registry source that
 need to be loaded onto the FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The featureRegistrySource.

    • getFeatureRegistrySourceOrBuilder

      FeatureView.FeatureRegistrySourceOrBuilder getFeatureRegistrySourceOrBuilder()
       Optional. Configures the features from a Feature Registry source that
 need to be loaded onto the FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.FeatureRegistrySource feature_registry_source = 9 [(.google.api.field_behavior) = OPTIONAL];

    • hasVertexRagSource

      boolean hasVertexRagSource()
       Optional. The Vertex RAG Source that the FeatureView is linked to.
      .google.cloud.aiplatform.v1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the vertexRagSource field is set.

    • getVertexRagSource

      FeatureView.VertexRagSource getVertexRagSource()
       Optional. The Vertex RAG Source that the FeatureView is linked to.
      .google.cloud.aiplatform.v1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The vertexRagSource.

    • getVertexRagSourceOrBuilder

      FeatureView.VertexRagSourceOrBuilder getVertexRagSourceOrBuilder()
       Optional. The Vertex RAG Source that the FeatureView is linked to.
      .google.cloud.aiplatform.v1.FeatureView.VertexRagSource vertex_rag_source = 18 [(.google.api.field_behavior) = OPTIONAL];

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp when this FeatureView was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this FeatureView was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this FeatureView was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Timestamp when this FeatureView was last updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this FeatureView was last updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this FeatureView was last updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getEtag

      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:
      The etag.

    • getEtagBytes

      com.google.protobuf.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:
      The bytes for etag.

    • getLabelsCount

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

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

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

    • getLabelsOrDefault

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

    • getLabelsOrThrow

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

    • hasSyncConfig

      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.v1.FeatureView.SyncConfig sync_config = 7;
      Returns:
      Whether the syncConfig field is set.

    • getSyncConfig

      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.v1.FeatureView.SyncConfig sync_config = 7;
      Returns:
      The syncConfig.

    • getSyncConfigOrBuilder

      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.v1.FeatureView.SyncConfig sync_config = 7;

    • hasIndexConfig

      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.v1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the indexConfig field is set.

    • getIndexConfig

      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.v1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The indexConfig.

    • getIndexConfigOrBuilder

      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.v1.FeatureView.IndexConfig index_config = 15 [(.google.api.field_behavior) = OPTIONAL];

    • hasOptimizedConfig

      boolean hasOptimizedConfig()
       Optional. Configuration for FeatureView created under Optimized
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the optimizedConfig field is set.

    • getOptimizedConfig

      FeatureView.OptimizedConfig getOptimizedConfig()
       Optional. Configuration for FeatureView created under Optimized
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The optimizedConfig.

    • getOptimizedConfigOrBuilder

      FeatureView.OptimizedConfigOrBuilder getOptimizedConfigOrBuilder()
       Optional. Configuration for FeatureView created under Optimized
 FeatureOnlineStore.
      .google.cloud.aiplatform.v1.FeatureView.OptimizedConfig optimized_config = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getServiceAgentTypeValue

      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.v1.FeatureView.ServiceAgentType service_agent_type = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for serviceAgentType.

    • getServiceAgentType

      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.v1.FeatureView.ServiceAgentType service_agent_type = 14 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The serviceAgentType.

    • getServiceAccountEmail

      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:
      The serviceAccountEmail.

    • getServiceAccountEmailBytes

      com.google.protobuf.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:
      The bytes for serviceAccountEmail.

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzi.

    • hasBigtableMetadata

      boolean hasBigtableMetadata()
       Metadata containing information about the Cloud Bigtable.
      .google.cloud.aiplatform.v1.FeatureView.BigtableMetadata bigtable_metadata = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the bigtableMetadata field is set.

    • getBigtableMetadata

      FeatureView.BigtableMetadata getBigtableMetadata()
       Metadata containing information about the Cloud Bigtable.
      .google.cloud.aiplatform.v1.FeatureView.BigtableMetadata bigtable_metadata = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bigtableMetadata.

    • getBigtableMetadataOrBuilder

      FeatureView.BigtableMetadataOrBuilder getBigtableMetadataOrBuilder()
       Metadata containing information about the Cloud Bigtable.
      .google.cloud.aiplatform.v1.FeatureView.BigtableMetadata bigtable_metadata = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSourceCase

      FeatureView.SourceCase getSourceCase()