featurestores

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

Overview

Name	featurestores
Type	Resource
Id	google.aiplatform.featurestores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
createTime	string (google-datetime)	Output only. Timestamp when this Featurestore was created.
encryptionSpec	object	Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage 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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
onlineServingConfig	object	Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving. (id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig)
onlineStorageTtlDays	integer (int32)	Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. State of the featurestore. (STATE_UNSPECIFIED, STABLE, UPDATING)
updateTime	string (google-datetime)	Output only. Timestamp when this Featurestore was last updated.

list

Name	Datatype	Description
name	string	Output only. Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
createTime	string (google-datetime)	Output only. Timestamp when this Featurestore was created.
encryptionSpec	object	Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage 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 Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
onlineServingConfig	object	Optional. Config for online storage resources. The field should not co-exist with the field of OnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving. (id: GoogleCloudAiplatformV1FeaturestoreOnlineServingConfig)
onlineStorageTtlDays	integer (int32)	Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than online_storage_ttl_days since the feature generation time. Note that online_storage_ttl_days should be less than or equal to offline_storage_ttl_days for each EntityType under a featurestore. If not set, default to 4000 days
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. State of the featurestore. (STATE_UNSPECIFIED, STABLE, UPDATING)
updateTime	string (google-datetime)	Output only. Timestamp when this Featurestore was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, featurestoresId		Gets details of a single Featurestore.
list	select	projectsId, locationsId	filter, pageToken, orderBy, pageSize, readMask	Lists Featurestores in a given project and location.
create	insert	projectsId, locationsId	featurestoreId	Creates a new Featurestore in a given project and location.
patch	update	projectsId, locationsId, featurestoresId	updateMask	Updates the parameters of a single Featurestore.
delete	delete	projectsId, locationsId, featurestoresId	force	Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.
search_features	exec	projectsId, locationsId	query, pageSize, pageToken	Searches Features matching a query in a given project.
batch_read_feature_values	exec	projectsId, locationsId, featurestoresId		Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

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
featurestoresId	string
locationsId	string
projectsId	string
featurestoreId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
query	string
readMask	string (google-fieldmask)
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Featurestore.

SELECT
name,
createTime,
encryptionSpec,
etag,
labels,
onlineServingConfig,
onlineStorageTtlDays,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.aiplatform.featurestores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND featurestoresId = '{{ featurestoresId }}' -- required
;

list

Lists Featurestores in a given project and location.

SELECT
name,
createTime,
encryptionSpec,
etag,
labels,
onlineServingConfig,
onlineStorageTtlDays,
satisfiesPzi,
satisfiesPzs,
state,
updateTime
FROM google.aiplatform.featurestores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND readMask = '{{ readMask }}'
;

INSERT examples

create

Creates a new Featurestore in a given project and location.

INSERT INTO google.aiplatform.featurestores (
data__encryptionSpec,
data__labels,
data__onlineServingConfig,
data__onlineStorageTtlDays,
data__etag,
projectsId,
locationsId,
featurestoreId
)
SELECT 
'{{ encryptionSpec }}',
'{{ labels }}',
'{{ onlineServingConfig }}',
{{ onlineStorageTtlDays }},
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ featurestoreId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: featurestores
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the featurestores resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the featurestores resource.
  - name: encryptionSpec
    description: |
      Optional. Customer-managed encryption key spec for data storage. If set, both of the online and offline data storage will be secured by this key.
    value:
      kmsKeyName: "{{ kmsKeyName }}"
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. The labels with user-defined metadata to organize your Featurestore. 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 Featurestore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
  - name: onlineServingConfig
    description: |
      Optional. Config for online storage resources. The field should not co-exist with the field of `OnlineStoreReplicationConfig`. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
    value:
      scaling:
        minNodeCount: {{ minNodeCount }}
        cpuUtilizationTarget: {{ cpuUtilizationTarget }}
        maxNodeCount: {{ maxNodeCount }}
      fixedNodeCount: {{ fixedNodeCount }}
  - name: onlineStorageTtlDays
    value: {{ onlineStorageTtlDays }}
    description: |
      Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
  - name: featurestoreId
    value: "{{ featurestoreId }}"

UPDATE examples

patch

Updates the parameters of a single Featurestore.

UPDATE google.aiplatform.featurestores
SET 
data__encryptionSpec = '{{ encryptionSpec }}',
data__labels = '{{ labels }}',
data__onlineServingConfig = '{{ onlineServingConfig }}',
data__onlineStorageTtlDays = {{ onlineStorageTtlDays }},
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featurestoresId = '{{ featurestoresId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.

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

Lifecycle Methods

search_features

Searches Features matching a query in a given project.

EXEC google.aiplatform.featurestores.search_features 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@query='{{ query }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}'
;

batch_read_feature_values

Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.

EXEC google.aiplatform.featurestores.batch_read_feature_values 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@featurestoresId='{{ featurestoresId }}' --required 
@@json=
'{
"destination": "{{ destination }}", 
"csvReadInstances": "{{ csvReadInstances }}", 
"bigqueryReadInstances": "{{ bigqueryReadInstances }}", 
"passThroughFields": "{{ passThroughFields }}", 
"entityTypeSpecs": "{{ entityTypeSpecs }}", 
"startTime": "{{ startTime }}"
}'
;