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 message google.cloud.aiplatform.v1.Featurestore
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Name of the Featurestore. Format: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this Featurestore was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this Featurestore 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 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. See https://goo.gl/xmQnxf for 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. |
↳ online_serving_config |
Featurestore\OnlineServingConfig
Optional. Config for online storage resources. The field should not co-exist with the field of |
↳ 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 than |
↳ encryption_spec |
EncryptionSpec
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. |
↳ satisfies_pzs |
bool
Output only. Reserved for future use. |
↳ satisfies_pzi |
bool
Output only. Reserved for future use. |
getName
Output only. Name of the Featurestore. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Name of the Featurestore. Format:
projects/{project}/locations/{location}/featurestores/{featurestore}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when this Featurestore was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Featurestore was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when this Featurestore was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this Featurestore 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 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. See https://goo.gl/xmQnxf for 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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. See https://goo.gl/xmQnxf for 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOnlineServingConfig
Optional. Config for online storage resources. The field should not
co-exist with the field of OnlineStoreReplicationConfig. If both of it
and OnlineStoreReplicationConfig are unset, the feature store will not have
an online store and cannot be used for online serving.
| Returns | |
|---|---|
| Type | Description |
Featurestore\OnlineServingConfig|null |
|
hasOnlineServingConfig
clearOnlineServingConfig
setOnlineServingConfig
Optional. Config for online storage resources. The field should not
co-exist with the field of OnlineStoreReplicationConfig. If both of it
and OnlineStoreReplicationConfig are unset, the feature store will not have
an online store and cannot be used for online serving.
| Parameter | |
|---|---|
| Name | Description |
var |
Featurestore\OnlineServingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the featurestore.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the featurestore.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOnlineStorageTtlDays
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 than online_storage_ttl_days since the
feature generation time. Note that online_storage_ttl_days should be less
than or equal to offline_storage_ttl_days for 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 than online_storage_ttl_days since the
feature generation time. Note that online_storage_ttl_days should be less
than or equal to offline_storage_ttl_days for 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.
| Returns | |
|---|---|
| Type | Description |
EncryptionSpec|null |
|
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
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.
| Parameter | |
|---|---|
| Name | Description |
var |
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 |
|