Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EntityType.
An entity type is a type of object in a system that needs to be modeled and
have stored information about. For example, driver is an entity type, and
driver0 is an instance of an entity type driver.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.EntityType
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Immutable. Name of the EntityType. Format:projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}The last part entity_type 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.
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. Seehttps://goo.gl/xmQnxffor 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.
↳ etag
string
Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Optional. The default monitoring configuration for all Features with value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under this EntityType. If this is populated with [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is disabled.
↳ offline_storage_ttl_days
int
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 thanoffline_storage_ttl_dayssince the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Immutable. Name of the EntityType.
Format:projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}The last part entity_type 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.
Returns
Type
Description
string
setName
Immutable. Name of the EntityType.
Format:projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}The last part entity_type 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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Optional. Description of the EntityType.
Returns
Type
Description
string
setDescription
Optional. Description of the EntityType.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCreateTime
Output only. Timestamp when this EntityType was created.
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.
Seehttps://goo.gl/xmQnxffor 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.
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.
Seehttps://goo.gl/xmQnxffor 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.
Optional. Used to perform a consistent read-modify-write updates. If not
set, a blind "overwrite" update happens.
Returns
Type
Description
string
setEtag
Optional. Used to perform a consistent read-modify-write updates. If not
set, a blind "overwrite" update happens.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMonitoringConfig
Optional. The default monitoring configuration for all Features with value
type
(Feature.ValueType) BOOL,
STRING, DOUBLE or INT64 under this EntityType.
If this is populated with
[FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
disabled.
Optional. The default monitoring configuration for all Features with value
type
(Feature.ValueType) BOOL,
STRING, DOUBLE or INT64 under this EntityType.
If this is populated with
[FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot
analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is
disabled.
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 thanoffline_storage_ttl_dayssince the feature generation
time. If unset (or explicitly set to 0), default to 4000 days TTL.
Returns
Type
Description
int
setOfflineStorageTtlDays
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 thanoffline_storage_ttl_dayssince the feature generation
time. If unset (or explicitly set to 0), default to 4000 days TTL.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class EntityType (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.EntityType)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.EntityType)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.EntityType)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.EntityType)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.EntityType)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.EntityType)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.EntityType)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.EntityType)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.EntityType)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.EntityType)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.EntityType)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.EntityType)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.EntityType)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.EntityType)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.EntityType)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.EntityType)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.EntityType)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.EntityType)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.EntityType)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.EntityType)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.EntityType)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.EntityType)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.EntityType)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.EntityType)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.EntityType)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.EntityType)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.EntityType)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.EntityType)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.EntityType)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.EntityType)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.EntityType)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.EntityType)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.EntityType)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.EntityType)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.EntityType)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.EntityType)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.EntityType)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.EntityType)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.EntityType)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.EntityType)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.EntityType)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.EntityType)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.EntityType)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.EntityType)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.EntityType)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.EntityType)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.EntityType)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.EntityType)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.EntityType)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.EntityType)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.EntityType)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.EntityType)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.EntityType)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.EntityType)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.EntityType)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.EntityType) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class EntityType.\n\nAn entity type is a type of object in a system that needs to be modeled and\nhave stored information about. For example, driver is an entity type, and\ndriver0 is an instance of an entity type driver.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.EntityType`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nImmutable. Name of the EntityType.\n\nFormat:\n`projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`\nThe last part entity_type is assigned by the client. The entity_type can be\nup to 64 characters long and can consist only of ASCII Latin letters A-Z\nand a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The\nvalue will be unique given a featurestore.\n\n### setName\n\nImmutable. Name of the EntityType.\n\nFormat:\n`projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`\nThe last part entity_type is assigned by the client. The entity_type can be\nup to 64 characters long and can consist only of ASCII Latin letters A-Z\nand a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The\nvalue will be unique given a featurestore.\n\n### getDescription\n\nOptional. Description of the EntityType.\n\n### setDescription\n\nOptional. Description of the EntityType.\n\n### getCreateTime\n\nOutput only. Timestamp when this EntityType was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this EntityType was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this EntityType was most recently updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this EntityType was most recently updated.\n\n### getLabels\n\nOptional. The labels with user-defined metadata to organize your\nEntityTypes.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information on and examples of labels.\nNo more than 64 user labels can be associated with one EntityType (System\nlabels are excluded).\"\nSystem reserved label keys are prefixed with \"aiplatform.googleapis.com/\"\nand are immutable.\n\n### setLabels\n\nOptional. The labels with user-defined metadata to organize your\nEntityTypes.\n\nLabel keys and values can be no longer than 64 characters\n(Unicode codepoints), can only contain lowercase letters, numeric\ncharacters, underscores and dashes. International characters are allowed.\nSee \u003chttps://goo.gl/xmQnxf\u003e for more information on and examples of labels.\nNo more than 64 user labels can be associated with one EntityType (System\nlabels are excluded).\"\nSystem reserved label keys are prefixed with \"aiplatform.googleapis.com/\"\nand are immutable.\n\n### getEtag\n\nOptional. Used to perform a consistent read-modify-write updates. If not\nset, a blind \"overwrite\" update happens.\n\n### setEtag\n\nOptional. Used to perform a consistent read-modify-write updates. If not\nset, a blind \"overwrite\" update happens.\n\n### getMonitoringConfig\n\nOptional. The default monitoring configuration for all Features with value\ntype\n([Feature.ValueType](/php/docs/reference/cloud-ai-platform/latest/V1.Feature.ValueType)) BOOL,\nSTRING, DOUBLE or INT64 under this EntityType.\n\nIf this is populated with\n\\[FeaturestoreMonitoringConfig.monitoring_interval\\] specified, snapshot\nanalysis monitoring is enabled. Otherwise, snapshot analysis monitoring is\ndisabled.\n\n### hasMonitoringConfig\n\n### clearMonitoringConfig\n\n### setMonitoringConfig\n\nOptional. The default monitoring configuration for all Features with value\ntype\n([Feature.ValueType](/php/docs/reference/cloud-ai-platform/latest/V1.Feature.ValueType)) BOOL,\nSTRING, DOUBLE or INT64 under this EntityType.\n\nIf this is populated with\n\\[FeaturestoreMonitoringConfig.monitoring_interval\\] specified, snapshot\nanalysis monitoring is enabled. Otherwise, snapshot analysis monitoring is\ndisabled.\n\n### getOfflineStorageTtlDays\n\nOptional. Config for data retention policy in offline storage.\n\nTTL in days for feature values that will be stored in offline storage.\nThe Feature Store offline storage periodically removes obsolete feature\nvalues older than `offline_storage_ttl_days` since the feature generation\ntime. If unset (or explicitly set to 0), default to 4000 days TTL.\n\n### setOfflineStorageTtlDays\n\nOptional. Config for data retention policy in offline storage.\n\nTTL in days for feature values that will be stored in offline storage.\nThe Feature Store offline storage periodically removes obsolete feature\nvalues older than `offline_storage_ttl_days` since the feature generation\ntime. If unset (or explicitly set to 0), default to 4000 days TTL.\n\n### getSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzs\n\nOutput only. Reserved for future use.\n\n### getSatisfiesPzi\n\nOutput only. Reserved for future use.\n\n### setSatisfiesPzi\n\nOutput only. Reserved for future use."]]
