Google Cloud Ai Platform V1 Client - Class Feature (0.11.1)

Version 0.11.1

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

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: 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.
↳ 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.

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.

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

Required. Immutable. Type of Feature value.

Returns
Type	Description
int

setValueType

Required. Immutable. Type of Feature value.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp when this EntityType was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this EntityType was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp when this EntityType was most recently updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. 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. 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. 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. The list of historical stats and anomalies with specified objectives.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setMonitoringStatsAnomalies

Output only. 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