featurestores

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

Overview

Name	featurestores
Type	Resource
Id	google.aiplatform.featurestores

Fields

Name	Datatype	Description
name	string	Output only. Name of the Featurestore. Format: projects/{project}/locations/{location}/featurestores/{featurestore}
createTime	string	Output only. Timestamp when this Featurestore was created.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
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	OnlineServingConfig specifies the details for provisioning online serving resources.
onlineStorageTtlDays	integer	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.
updateTime	string	Output only. Timestamp when this Featurestore was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	featurestoresId, locationsId, projectsId	Gets details of a single Featurestore.
list	SELECT	locationsId, projectsId	Lists Featurestores in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new Featurestore in a given project and location.
delete	DELETE	featurestoresId, locationsId, projectsId	Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or force must be set to true for the request to succeed.
patch	UPDATE	featurestoresId, locationsId, projectsId	Updates the parameters of a single Featurestore.
batch_read_feature_values	EXEC	featurestoresId, locationsId, projectsId	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.
search_features	EXEC	locationsId, projectsId	Searches Features matching a query in a given project.

SELECT examples

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 locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new featurestores resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.featurestores (
locationsId,
projectsId,
onlineStorageTtlDays,
labels,
encryptionSpec,
etag,
onlineServingConfig
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ onlineStorageTtlDays }}',
'{{ labels }}',
'{{ encryptionSpec }}',
'{{ etag }}',
'{{ onlineServingConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: onlineStorageTtlDays
      value: integer
    - name: updateTime
      value: string
    - name: satisfiesPzs
      value: boolean
    - name: labels
      value: object
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string
    - name: etag
      value: string
    - name: satisfiesPzi
      value: boolean
    - name: state
      value: string
    - name: name
      value: string
    - name: onlineServingConfig
      value:
        - name: fixedNodeCount
          value: integer
        - name: scaling
          value:
            - name: cpuUtilizationTarget
              value: integer
            - name: minNodeCount
              value: integer
            - name: maxNodeCount
              value: integer
    - name: createTime
      value: string

UPDATE example

Updates a featurestores resource.

/*+ update */
UPDATE google.aiplatform.featurestores
SET 
onlineStorageTtlDays = '{{ onlineStorageTtlDays }}',
labels = '{{ labels }}',
encryptionSpec = '{{ encryptionSpec }}',
etag = '{{ etag }}',
onlineServingConfig = '{{ onlineServingConfig }}'
WHERE 
featurestoresId = '{{ featurestoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified featurestores resource.

/*+ delete */
DELETE FROM google.aiplatform.featurestores
WHERE featurestoresId = '{{ featurestoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';