Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Feature.
Feature Metadata information.
For example, color is a feature that describes an apple.
Generated from protobuf message google.cloud.aiplatform.v1.Feature
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Name of the Feature. Format: |
↳ description |
string
Description of the Feature. |
↳ value_type |
int
Immutable. Only applicable for Vertex AI Feature Store (Legacy). Type of Feature value. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was most recently updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. The labels with user-defined metadata to organize your Features. 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 Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. |
↳ etag |
string
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
↳ disable_monitoring |
bool
Optional. Only applicable for Vertex AI Feature Store (Legacy). If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType. |
↳ monitoring_stats_anomalies |
array<Google\Cloud\AIPlatform\V1\Feature\MonitoringStatsAnomaly>
Output only. Only applicable for Vertex AI Feature Store (Legacy). The list of historical stats and anomalies with specified objectives. |
↳ version_column_name |
string
Only applicable for Vertex AI Feature Store. The name of the BigQuery Table/View columnn hosting data for this version. If no value is provided, will use feature_id. |
getName
Immutable. Name of the Feature.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}
The last part feature is assigned by the client. The feature can be up to
64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
underscore(_), and ASCII digits 0-9 starting with a letter. The value will
be unique given an entity type.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Immutable. Name of the Feature.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}
projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}
The last part feature is assigned by the client. The feature can be up to
64 characters long and can consist only of ASCII Latin letters A-Z and a-z,
underscore(_), and ASCII digits 0-9 starting with a letter. The value will
be unique given an entity type.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the Feature.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the Feature.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValueType
Immutable. Only applicable for Vertex AI Feature Store (Legacy).
Type of Feature value.
| Returns | |
|---|---|
| Type | Description |
int | |
setValueType
Immutable. Only applicable for Vertex AI Feature Store (Legacy).
Type of Feature value.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Only applicable for Vertex AI Feature Store (Legacy).
Timestamp when this EntityType was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Only applicable for Vertex AI Feature Store (Legacy).
Timestamp when this EntityType was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Only applicable for Vertex AI Feature Store (Legacy).
Timestamp when this EntityType was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Only applicable for Vertex AI Feature Store (Legacy).
Timestamp when this EntityType was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Optional. The labels with user-defined metadata to organize your Features.
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 Feature (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 Features.
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 Feature (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 | |
getEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisableMonitoring
Optional. Only applicable for Vertex AI Feature Store (Legacy).
If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDisableMonitoring
Optional. Only applicable for Vertex AI Feature Store (Legacy).
If not set, use the monitoring_config defined for the EntityType this Feature belongs to. Only Features with type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 can enable monitoring. If set to true, all types of data monitoring are disabled despite the config on EntityType.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMonitoringStatsAnomalies
Output only. Only applicable for Vertex AI Feature Store (Legacy).
The list of historical stats and anomalies with specified objectives.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMonitoringStatsAnomalies
Output only. Only applicable for Vertex AI Feature Store (Legacy).
The list of historical stats and anomalies with specified objectives.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\Feature\MonitoringStatsAnomaly>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVersionColumnName
Only applicable for Vertex AI Feature Store.
The name of the BigQuery Table/View columnn hosting data for this version. If no value is provided, will use feature_id.
| Returns | |
|---|---|
| Type | Description |
string | |
setVersionColumnName
Only applicable for Vertex AI Feature Store.
The name of the BigQuery Table/View columnn hosting data for this version. If no value is provided, will use feature_id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |