Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Feature.
Feature Metadata information that describes an attribute of an entity type.
For example, apple is an entity type, and color is a feature that describes apple.
Generated from protobuf message google.cloud.aiplatform.v1.Feature
Methods
__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
Required. Immutable. Type of Feature value. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when this EntityType was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. 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. 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. The list of historical stats and anomalies with specified objectives. |
getName
Immutable. Name of the Feature.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Immutable. Name of the Feature.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Description of the Feature.
Generated from protobuf field string description = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Description of the Feature.
Generated from protobuf field string description = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValueType
Required. Immutable. Type of Feature value.
Generated from protobuf field .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int | |
setValueType
Required. Immutable. Type of Feature value.
Generated from protobuf field .google.cloud.aiplatform.v1.Feature.ValueType value_type = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. Timestamp when this EntityType was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this EntityType was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. Timestamp when this EntityType was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this EntityType was most recently updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field string etag = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisableMonitoring
Optional. 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.
Generated from protobuf field bool disable_monitoring = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setDisableMonitoring
Optional. 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.
Generated from protobuf field bool disable_monitoring = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMonitoringStatsAnomalies
Output only. The list of historical stats and anomalies with specified objectives.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setMonitoringStatsAnomalies
Output only. The list of historical stats and anomalies with specified objectives.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.Feature.MonitoringStatsAnomaly monitoring_stats_anomalies = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\Feature\MonitoringStatsAnomaly>
|
| Returns | |
|---|---|
| Type | Description |
$this | |