REST Resource: projects.locations.featureOnlineStores

Resource: FeatureOnlineStore

Vertex AI feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The feature Online Store is a top-level container.

Fields
name string

Identifier. name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}

createTime string (Timestamp format)

Output only. timestamp when this FeatureOnlineStore was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. timestamp when this FeatureOnlineStore was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

etag string

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

labels map (key: string, value: string)

Optional. The labels with user-defined metadata to organize your FeatureOnlineStore.

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.

state enum (State)

Output only. state of the featureOnlineStore.

dedicatedServingEndpoint object (DedicatedServingEndpoint)

Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.

embeddingManagement
(deprecated) object (EmbeddingManagement)

Optional. Deprecated: This field is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type.

encryptionSpec object (EncryptionSpec)

Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key.

satisfiesPzs boolean

Output only. reserved for future use.

satisfiesPzi boolean

Output only. reserved for future use.

storage_type Union type
storage_type can be only one of the following:
bigtable object (Bigtable)

Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.

optimized object (Optimized)

Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "dedicatedServingEndpoint": {
    object (DedicatedServingEndpoint)
  },
  "embeddingManagement": {
    object (EmbeddingManagement)
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,

  // storage_type
  "bigtable": {
    object (Bigtable)
  },
  "optimized": {
    object (Optimized)
  }
  // Union type
}

Bigtable

Fields
autoScaling object (AutoScaling)

Required. Autoscaling config applied to Bigtable Instance.

JSON representation 
{
  "autoScaling": {
    object (AutoScaling)
  }
}

AutoScaling

Fields
minNodeCount integer

Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.

maxNodeCount integer

Required. The maximum number of nodes to scale up to. Must be greater than or equal to minNodeCount, and less than or equal to 10 times of 'minNodeCount'.

cpuUtilizationTarget integer

Optional. A percentage of the cluster's CPU capacity. Can be from 10% to 80%. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set will default to 50%.

JSON representation 
{
  "minNodeCount": integer,
  "maxNodeCount": integer,
  "cpuUtilizationTarget": integer
}

Optimized

This type has no fields.

Optimized storage type

State

Possible states a featureOnlineStore can have.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
STABLE state when the featureOnlineStore configuration is not being updated and the fields reflect the current configuration of the featureOnlineStore. The featureOnlineStore is usable in this state.
UPDATING The state of the featureOnlineStore configuration when it is being updated. During an update, the fields reflect either the original configuration or the updated configuration of the featureOnlineStore. The featureOnlineStore is still usable in this state.

DedicatedServingEndpoint

The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.

Fields
publicEndpointDomainName string

Output only. This field will be populated with the domain name to use for this FeatureOnlineStore

privateServiceConnectConfig object (PrivateServiceConnectConfig)

Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint.

serviceAttachment string

Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created.

JSON representation 
{
  "publicEndpointDomainName": string,
  "privateServiceConnectConfig": {
    object (PrivateServiceConnectConfig)
  },
  "serviceAttachment": string
}

EmbeddingManagement

Deprecated: This sub message is no longer needed anymore and embedding management is automatically enabled when specifying Optimized storage type. Contains settings for embedding management.

Fields
enabled boolean

Optional. Immutable. Whether to enable embedding management in this FeatureOnlineStore. It's immutable after creation to ensure the FeatureOnlineStore availability.

JSON representation 
{
  "enabled": boolean
}

Methods

create

 Creates a new FeatureOnlineStore in a given project and location.

delete

 Deletes a single FeatureOnlineStore.

get

 Gets details of a single FeatureOnlineStore.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists FeatureOnlineStores in a given project and location.

patch

 Updates the parameters of a single FeatureOnlineStore.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.