Google Cloud Ai Platform V1 Client - Class Featurestore (0.12.0)

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

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}`
`↳ 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`	`Google\Cloud\AIPlatform\V1\Featurestore\OnlineServingConfig` 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.
`↳ state`	`int` Output only. State of the featurestore.
`↳ encryption_spec`	`Google\Cloud\AIPlatform\V1\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.

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.

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
`Google\Cloud\AIPlatform\V1\Featurestore\OnlineServingConfig\|null`

hasOnlineServingConfig

clearOnlineServingConfig

setOnlineServingConfig

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\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`

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
`Google\Cloud\AIPlatform\V1\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`	`Google\Cloud\AIPlatform\V1\EncryptionSpec`

Returns
Type	Description
`$this`