feature_online_stores

Creates, updates, deletes, gets or lists a feature_online_stores resource.

Overview

Name	feature_online_stores
Type	Resource
Id	google.aiplatform.feature_online_stores

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}
bigtable	object	Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. (id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable)
createTime	string (google-datetime)	Output only. Timestamp when this FeatureOnlineStore was created.
dedicatedServingEndpoint	object	Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. (id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint)
encryptionSpec	object	Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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.
optimized	object	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. (id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. State of the featureOnlineStore.
updateTime	string (google-datetime)	Output only. Timestamp when this FeatureOnlineStore was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the FeatureOnlineStore. Format: projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}
bigtable	object	Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. (id: GoogleCloudAiplatformV1FeatureOnlineStoreBigtable)
createTime	string (google-datetime)	Output only. Timestamp when this FeatureOnlineStore was created.
dedicatedServingEndpoint	object	Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. (id: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint)
encryptionSpec	object	Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key. (id: GoogleCloudAiplatformV1EncryptionSpec)
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	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.
optimized	object	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. (id: GoogleCloudAiplatformV1FeatureOnlineStoreOptimized)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. State of the featureOnlineStore.
updateTime	string (google-datetime)	Output only. Timestamp when this FeatureOnlineStore was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, featureOnlineStoresId		Gets details of a single FeatureOnlineStore.
list	select	projectsId, locationsId	filter, pageSize, pageToken, orderBy	Lists FeatureOnlineStores in a given project and location.
create	insert	projectsId, locationsId	featureOnlineStoreId	Creates a new FeatureOnlineStore in a given project and location.
patch	update	projectsId, locationsId, featureOnlineStoresId	updateMask	Updates the parameters of a single FeatureOnlineStore.
delete	delete	projectsId, locationsId, featureOnlineStoresId	force	Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
featureOnlineStoresId	string
locationsId	string
projectsId	string
featureOnlineStoreId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single FeatureOnlineStore.

SELECT
name,
bigtable,
createTime,
dedicatedServingEndpoint,
encryptionSpec,
etag,
labels,
optimized,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.aiplatform.feature_online_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND featureOnlineStoresId = '{{ featureOnlineStoresId }}' -- required;

list

Lists FeatureOnlineStores in a given project and location.

SELECT
name,
bigtable,
createTime,
dedicatedServingEndpoint,
encryptionSpec,
etag,
labels,
optimized,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.aiplatform.feature_online_stores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new FeatureOnlineStore in a given project and location.

INSERT INTO google.aiplatform.feature_online_stores (
data__bigtable,
data__optimized,
data__name,
data__etag,
data__labels,
data__dedicatedServingEndpoint,
data__encryptionSpec,
projectsId,
locationsId,
featureOnlineStoreId
)
SELECT 
'{{ bigtable }}',
'{{ optimized }}',
'{{ name }}',
'{{ etag }}',
'{{ labels }}',
'{{ dedicatedServingEndpoint }}',
'{{ encryptionSpec }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ featureOnlineStoreId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: feature_online_stores
  props:
    - name: projectsId
      value: string
      description: Required parameter for the feature_online_stores resource.
    - name: locationsId
      value: string
      description: Required parameter for the feature_online_stores resource.
    - name: bigtable
      value: object
      description: >
        Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.
        
    - name: optimized
      value: object
      description: >
        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.
        
    - name: name
      value: string
      description: >
        Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`
        
    - name: etag
      value: string
      description: >
        Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: dedicatedServingEndpoint
      value: object
      description: >
        Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
        
    - name: encryptionSpec
      value: object
      description: >
        Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key.
        
    - name: featureOnlineStoreId
      value: string

UPDATE examples

patch

Updates the parameters of a single FeatureOnlineStore.

UPDATE google.aiplatform.feature_online_stores
SET 
data__bigtable = '{{ bigtable }}',
data__optimized = '{{ optimized }}',
data__name = '{{ name }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__dedicatedServingEndpoint = '{{ dedicatedServingEndpoint }}',
data__encryptionSpec = '{{ encryptionSpec }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureOnlineStoresId = '{{ featureOnlineStoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.

DELETE FROM google.aiplatform.feature_online_stores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureOnlineStoresId = '{{ featureOnlineStoresId }}' --required
AND force = '{{ force }}';