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 message google.cloud.aiplatform.v1.FeatureOnlineStore
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ bigtable |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Bigtable
Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. |
↳ optimized |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Optimized
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 set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. |
↳ name |
string
Identifier. Name of the FeatureOnlineStore. Format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this FeatureOnlineStore was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this FeatureOnlineStore was last updated. |
↳ etag |
string
Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. See https://goo.gl/xmQnxf for 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. |
↳ state |
int
Output only. State of the featureOnlineStore. |
↳ dedicated_serving_endpoint |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\DedicatedServingEndpoint
Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. |
↳ encryption_spec |
Google\Cloud\AIPlatform\V1\EncryptionSpec
Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key. |
↳ satisfies_pzs |
bool
Output only. Reserved for future use. |
↳ satisfies_pzi |
bool
Output only. Reserved for future use. |
getBigtable
Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Bigtable|null |
|
hasBigtable
setBigtable
Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Bigtable
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptimized
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 set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Optimized|null |
|
hasOptimized
setOptimized
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 set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\Optimized
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Identifier. Name of the FeatureOnlineStore. Format:
projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Name of the FeatureOnlineStore. Format:
projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when this FeatureOnlineStore was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this FeatureOnlineStore was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when this FeatureOnlineStore was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this FeatureOnlineStore was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
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. See https://goo.gl/xmQnxf for 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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. See https://goo.gl/xmQnxf for 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the featureOnlineStore.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the featureOnlineStore.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDedicatedServingEndpoint
Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\DedicatedServingEndpoint|null |
|
hasDedicatedServingEndpoint
clearDedicatedServingEndpoint
setDedicatedServingEndpoint
Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\FeatureOnlineStore\DedicatedServingEndpoint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionSpec
Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\EncryptionSpec|null |
|
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\EncryptionSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSatisfiesPzs
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
Output only. Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSatisfiesPzi
Output only. Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStorageType
| Returns | |
|---|---|
| Type | Description |
string |
|