Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class FeatureOnlineStore.
Vertex AI Feature Online Store provides a centralized repository for serving
ML features and embedding indexes at low latency. The Feature Online Store is
a top-level container.
Generated from protobuf messagegoogle.cloud.aiplatform.v1.FeatureOnlineStore
Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to setPrivateServiceConnectConfig.enable_private_service_connectto use private endpoint. Otherwise will use public endpoint by default.
↳ name
string
Identifier. Name of the FeatureOnlineStore. Format:projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}
Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. 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 FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
Contains settings for the Optimized store that will be created
to serve featureValues for all FeatureViews under this
FeatureOnlineStore. When choose Optimized storage type, need to setPrivateServiceConnectConfig.enable_private_service_connectto use private endpoint. Otherwise will use public endpoint by default.
Contains settings for the Optimized store that will be created
to serve featureValues for all FeatureViews under this
FeatureOnlineStore. When choose Optimized storage type, need to setPrivateServiceConnectConfig.enable_private_service_connectto use private endpoint. Otherwise will use public endpoint by default.
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
FeatureOnlineStore.
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
FeatureOnlineStore(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
FeatureOnlineStore.
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
FeatureOnlineStore(System labels are excluded)." System reserved label keys
are prefixed with "aiplatform.googleapis.com/" and are immutable.
[[["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-09 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class FeatureOnlineStore (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.FeatureOnlineStore)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.FeatureOnlineStore)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.FeatureOnlineStore)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.FeatureOnlineStore)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.FeatureOnlineStore)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.FeatureOnlineStore)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.FeatureOnlineStore)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.FeatureOnlineStore)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.FeatureOnlineStore)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.FeatureOnlineStore)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.FeatureOnlineStore)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.FeatureOnlineStore)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.FeatureOnlineStore)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.FeatureOnlineStore)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.FeatureOnlineStore)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.FeatureOnlineStore)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.FeatureOnlineStore)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.FeatureOnlineStore)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.FeatureOnlineStore)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.FeatureOnlineStore)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.FeatureOnlineStore)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.FeatureOnlineStore)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.FeatureOnlineStore)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.FeatureOnlineStore)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.FeatureOnlineStore)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.FeatureOnlineStore)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.FeatureOnlineStore)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.FeatureOnlineStore)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.FeatureOnlineStore)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.FeatureOnlineStore)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.FeatureOnlineStore)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.FeatureOnlineStore)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.FeatureOnlineStore)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.FeatureOnlineStore)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.FeatureOnlineStore)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.FeatureOnlineStore)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.FeatureOnlineStore)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.FeatureOnlineStore)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.FeatureOnlineStore)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.FeatureOnlineStore)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.FeatureOnlineStore)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.FeatureOnlineStore)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.FeatureOnlineStore)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.FeatureOnlineStore)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.FeatureOnlineStore)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.FeatureOnlineStore)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.FeatureOnlineStore)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.FeatureOnlineStore)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.FeatureOnlineStore)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.FeatureOnlineStore)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.FeatureOnlineStore)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.FeatureOnlineStore)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.FeatureOnlineStore)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.FeatureOnlineStore)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.FeatureOnlineStore)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.FeatureOnlineStore) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class FeatureOnlineStore.\n\nVertex AI Feature Online Store provides a centralized repository for serving\nML features and embedding indexes at low latency. The Feature Online Store is\na top-level container.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.FeatureOnlineStore`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBigtable\n\nContains settings for the Cloud Bigtable instance that will be created\nto serve featureValues for all FeatureViews under this\nFeatureOnlineStore.\n\n### hasBigtable\n\n### setBigtable\n\nContains settings for the Cloud Bigtable instance that will be created\nto serve featureValues for all FeatureViews under this\nFeatureOnlineStore.\n\n### getOptimized\n\nContains settings for the Optimized store that will be created\nto serve featureValues for all FeatureViews under this\nFeatureOnlineStore. When choose Optimized storage type, need to set\n[PrivateServiceConnectConfig.enable_private_service_connect](/php/docs/reference/cloud-ai-platform/latest/V1.PrivateServiceConnectConfig#_Google_Cloud_AIPlatform_V1_PrivateServiceConnectConfig__getEnablePrivateServiceConnect__)\nto use private endpoint. Otherwise will use public endpoint by default.\n\n### hasOptimized\n\n### setOptimized\n\nContains settings for the Optimized store that will be created\nto serve featureValues for all FeatureViews under this\nFeatureOnlineStore. When choose Optimized storage type, need to set\n[PrivateServiceConnectConfig.enable_private_service_connect](/php/docs/reference/cloud-ai-platform/latest/V1.PrivateServiceConnectConfig#_Google_Cloud_AIPlatform_V1_PrivateServiceConnectConfig__getEnablePrivateServiceConnect__)\nto use private endpoint. Otherwise will use public endpoint by default.\n\n### getName\n\nIdentifier. Name of the FeatureOnlineStore. Format:\n`projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`\n\n### setName\n\nIdentifier. Name of the FeatureOnlineStore. Format:\n`projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`\n\n### getCreateTime\n\nOutput only. Timestamp when this FeatureOnlineStore was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Timestamp when this FeatureOnlineStore was created.\n\n### getUpdateTime\n\nOutput only. Timestamp when this FeatureOnlineStore was last updated.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. Timestamp when this FeatureOnlineStore 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\nFeatureOnlineStore.\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\nFeatureOnlineStore(System labels are excluded).\" System reserved label keys\nare prefixed with \"aiplatform.googleapis.com/\" and are immutable.\n\n### setLabels\n\nOptional. The labels with user-defined metadata to organize your\nFeatureOnlineStore.\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\nFeatureOnlineStore(System labels are excluded).\" System reserved label keys\nare prefixed with \"aiplatform.googleapis.com/\" and are immutable.\n\n### getState\n\nOutput only. State of the featureOnlineStore.\n\n### setState\n\nOutput only. State of the featureOnlineStore.\n\n### getDedicatedServingEndpoint\n\nOptional. The dedicated serving endpoint for this FeatureOnlineStore, which\nis different from common Vertex service endpoint.\n\n### hasDedicatedServingEndpoint\n\n### clearDedicatedServingEndpoint\n\n### setDedicatedServingEndpoint\n\nOptional. The dedicated serving endpoint for this FeatureOnlineStore, which\nis different from common Vertex service endpoint.\n\n### getEncryptionSpec\n\nOptional. Customer-managed encryption key spec for data storage. If set,\nonline store 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,\nonline store 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.\n\n### getStorageType"]]
