Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Featurestore.
Vertex AI Feature Store provides a centralized repository for organizing,
storing, and serving ML features. The Featurestore is a top-level container
for your features and their values.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.Featurestore
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of the Featurestore. Format:projects/{project}/locations/{location}/featurestores/{featurestore}
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. Seehttps://goo.gl/xmQnxffor 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.
Optional. Config for online storage resources. The field should not co-exist with the field ofOnlineStoreReplicationConfig. If both of it and OnlineStoreReplicationConfig are unset, the feature store will not have an online store and cannot be used for online serving.
↳ state
int
Output only. State of the featurestore.
↳ online_storage_ttl_days
int
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 thanonline_storage_ttl_dayssince the feature generation time. Note thatonline_storage_ttl_daysshould be less than or equal tooffline_storage_ttl_daysfor each EntityType under a featurestore. If not set, default to 4000 days
Optional. Used to perform consistent read-modify-write updates. If not set,
a blind "overwrite" update happens.
Returns
Type
Description
string
setEtag
Optional. Used to perform consistent read-modify-write updates. If not set,
a blind "overwrite" update happens.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLabels
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.
Seehttps://goo.gl/xmQnxffor 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.
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.
Seehttps://goo.gl/xmQnxffor 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.
Optional. Config for online storage resources. The field should not
co-exist with the field ofOnlineStoreReplicationConfig. If both of it
and OnlineStoreReplicationConfig are unset, the feature store will not have
an online store and cannot be used for online serving.
Optional. Config for online storage resources. The field should not
co-exist with the field ofOnlineStoreReplicationConfig. If both of it
and OnlineStoreReplicationConfig are unset, the feature store will not have
an online store and cannot be used for online serving.
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 thanonline_storage_ttl_dayssince the
feature generation time. Note thatonline_storage_ttl_daysshould be less
than or equal tooffline_storage_ttl_daysfor each EntityType under a
featurestore. If not set, default to 4000 days
Returns
Type
Description
int
setOnlineStorageTtlDays
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 thanonline_storage_ttl_dayssince the
feature generation time. Note thatonline_storage_ttl_daysshould be less
than or equal tooffline_storage_ttl_daysfor each EntityType under a
featurestore. If not set, default to 4000 days
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getEncryptionSpec
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.
[[["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 Featurestore (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.Featurestore)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.Featurestore)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.Featurestore)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.Featurestore)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.Featurestore)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.Featurestore)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.Featurestore)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.Featurestore)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.Featurestore)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.Featurestore)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.Featurestore)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.Featurestore)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.Featurestore)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.Featurestore)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.Featurestore)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.Featurestore)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.Featurestore)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.Featurestore)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.Featurestore)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.Featurestore)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.Featurestore)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.Featurestore)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.Featurestore)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.Featurestore)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.Featurestore)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.Featurestore)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.Featurestore)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.Featurestore)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.Featurestore)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.Featurestore)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.Featurestore)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.Featurestore)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.Featurestore)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.Featurestore)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.Featurestore)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.Featurestore)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.Featurestore)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.Featurestore)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.Featurestore)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.Featurestore)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.Featurestore)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.Featurestore)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.Featurestore)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.Featurestore)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.Featurestore)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.Featurestore)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.Featurestore)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.Featurestore)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.Featurestore)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.Featurestore)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.Featurestore)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.Featurestore)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.Featurestore)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.Featurestore)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.Featurestore)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.Featurestore) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class Featurestore.\n\nVertex AI Feature Store provides a centralized repository for organizing,\nstoring, and serving ML features. The Featurestore is a top-level container\nfor your features and their values.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.Featurestore`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Name of the Featurestore. Format:\n`projects/{project}/locations/{location}/featurestores/{featurestore}`\n\n### setName\n\nOutput only. Name of the Featurestore. Format:\n`projects/{project}/locations/{location}/featurestores/{featurestore}`\n\n### getCreateTime\n\nOutput only. Timestamp when this Featurestore was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this Featurestore was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this Featurestore was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this Featurestore was last updated.\n\n### getEtag\n\nOptional. Used to perform consistent read-modify-write updates. If not set,\na blind \"overwrite\" update happens.\n\n### setEtag\n\nOptional. Used to perform consistent read-modify-write updates. If not set,\na blind \"overwrite\" update happens.\n\n### getLabels\n\nOptional. The labels with user-defined metadata to organize your\nFeaturestore.\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 Featurestore(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\nFeaturestore.\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 Featurestore(System\nlabels are excluded).\"\nSystem reserved label keys are prefixed with \"aiplatform.googleapis.com/\"\nand are immutable.\n\n### getOnlineServingConfig\n\nOptional. Config for online storage resources. The field should not\nco-exist with the field of `OnlineStoreReplicationConfig`. If both of it\nand OnlineStoreReplicationConfig are unset, the feature store will not have\nan online store and cannot be used for online serving.\n\n### hasOnlineServingConfig\n\n### clearOnlineServingConfig\n\n### setOnlineServingConfig\n\nOptional. Config for online storage resources. The field should not\nco-exist with the field of `OnlineStoreReplicationConfig`. If both of it\nand OnlineStoreReplicationConfig are unset, the feature store will not have\nan online store and cannot be used for online serving.\n\n### getState\n\nOutput only. State of the featurestore.\n\n### setState\n\nOutput only. State of the featurestore.\n\n### getOnlineStorageTtlDays\n\nOptional. TTL in days for feature values that will be stored in online\nserving storage. The Feature Store online storage periodically removes\nobsolete feature values older than `online_storage_ttl_days` since the\nfeature generation time. Note that `online_storage_ttl_days` should be less\nthan or equal to `offline_storage_ttl_days` for each EntityType under a\nfeaturestore. If not set, default to 4000 days\n\n### setOnlineStorageTtlDays\n\nOptional. TTL in days for feature values that will be stored in online\nserving storage. The Feature Store online storage periodically removes\nobsolete feature values older than `online_storage_ttl_days` since the\nfeature generation time. Note that `online_storage_ttl_days` should be less\nthan or equal to `offline_storage_ttl_days` for each EntityType under a\nfeaturestore. If not set, default to 4000 days\n\n### getEncryptionSpec\n\nOptional. Customer-managed encryption key spec for data storage. If set,\nboth of the online and offline data storage will be secured by this key.\n\n### hasEncryptionSpec\n\n### clearEncryptionSpec\n\n### setEncryptionSpec\n\nOptional. Customer-managed encryption key spec for data storage. If set,\nboth of the online and offline data storage will be secured by this key.\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."]]
