entity_types

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

Overview

Name	entity_types
Type	Resource
Id	google.aiplatform.entity_types

Fields

Name	Datatype	Description
name	string	Immutable. Name of the EntityType. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entitytype is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.
description	string	Optional. Description of the EntityType.
createTime	string	Output only. Timestamp when this EntityType was created.
etag	string	Optional. Used to perform a 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 EntityTypes. 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 EntityType (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
monitoringConfig	object	Configuration of how features in Featurestore are monitored.
offlineStorageTtlDays	integer	Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than offline_storage_ttl_days since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
updateTime	string	Output only. Timestamp when this EntityType was most recently updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	entityTypesId, featurestoresId, locationsId, projectsId	Gets details of a single EntityType.
list	SELECT	featurestoresId, locationsId, projectsId	Lists EntityTypes in a given Featurestore.
create	INSERT	featurestoresId, locationsId, projectsId	Creates a new EntityType in a given Featurestore.
delete	DELETE	entityTypesId, featurestoresId, locationsId, projectsId	Deletes a single EntityType. The EntityType must not have any Features or force must be set to true for the request to succeed.
patch	UPDATE	entityTypesId, featurestoresId, locationsId, projectsId	Updates the parameters of a single EntityType.
export_feature_values	EXEC	entityTypesId, featurestoresId, locationsId, projectsId	Exports Feature values from all the entities of a target EntityType.
import_feature_values	EXEC	entityTypesId, featurestoresId, locationsId, projectsId	Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.
read_feature_values	EXEC	entityTypesId, featurestoresId, locationsId, projectsId	Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.
streaming_read_feature_values	EXEC	entityTypesId, featurestoresId, locationsId, projectsId	Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.
write_feature_values	EXEC	entityTypesId, featurestoresId, locationsId, projectsId	Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.

SELECT examples

Lists EntityTypes in a given Featurestore.

SELECT
name,
description,
createTime,
etag,
labels,
monitoringConfig,
offlineStorageTtlDays,
satisfiesPzi,
satisfiesPzs,
updateTime
FROM google.aiplatform.entity_types
WHERE featurestoresId = '{{ featurestoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.aiplatform.entity_types (
featurestoresId,
locationsId,
projectsId,
name,
etag,
offlineStorageTtlDays,
labels,
description,
monitoringConfig
)
SELECT 
'{{ featurestoresId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ etag }}',
'{{ offlineStorageTtlDays }}',
'{{ labels }}',
'{{ description }}',
'{{ monitoringConfig }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: updateTime
      value: string
    - name: etag
      value: string
    - name: offlineStorageTtlDays
      value: integer
    - name: labels
      value: object
    - name: satisfiesPzs
      value: boolean
    - name: createTime
      value: string
    - name: satisfiesPzi
      value: boolean
    - name: description
      value: string
    - name: monitoringConfig
      value:
        - name: numericalThresholdConfig
          value:
            - name: value
              value: number
        - name: snapshotAnalysis
          value:
            - name: disabled
              value: boolean
            - name: monitoringIntervalDays
              value: integer
            - name: stalenessDays
              value: integer
        - name: importFeaturesAnalysis
          value:
            - name: anomalyDetectionBaseline
              value: string
            - name: state
              value: string

UPDATE example

Updates a entity_types resource.

/*+ update */
UPDATE google.aiplatform.entity_types
SET 
name = '{{ name }}',
etag = '{{ etag }}',
offlineStorageTtlDays = '{{ offlineStorageTtlDays }}',
labels = '{{ labels }}',
description = '{{ description }}',
monitoringConfig = '{{ monitoringConfig }}'
WHERE 
entityTypesId = '{{ entityTypesId }}'
AND featurestoresId = '{{ featurestoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified entity_types resource.

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