Google Cloud Ai Platform V1 Client - Class EntityType (0.10.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EntityType.

An entity type is a type of object in a system that needs to be modeled and have stored information about. For example, driver is an entity type, and driver0 is an instance of an entity type driver.

Generated from protobuf message google.cloud.aiplatform.v1.EntityType

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Immutable. Name of the EntityType. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

↳ description string

Optional. Description of the EntityType.

↳ 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 EntityTypes. 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 EntityType (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

↳ etag string

Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

↳ monitoring_config Google\Cloud\AIPlatform\V1\FeaturestoreMonitoringConfig

Optional. The default monitoring configuration for all Features with value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under this EntityType. If this is populated with [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is disabled.

getName

Immutable. Name of the EntityType.

Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
string

setName

Immutable. Name of the EntityType.

Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type} The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Description of the EntityType.

Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setDescription

Optional. Description of the EntityType.

Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Timestamp when this EntityType was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this EntityType was created.

Generated from protobuf field .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
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 = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. The labels with user-defined metadata to organize your EntityTypes.

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 EntityType (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
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels with user-defined metadata to organize your EntityTypes.

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 EntityType (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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getEtag

Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Generated from protobuf field string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setEtag

Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Generated from protobuf field string etag = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMonitoringConfig

Optional. The default monitoring configuration for all Features with value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under this EntityType.

If this is populated with [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is disabled.

Generated from protobuf field .google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\FeaturestoreMonitoringConfig|null

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Optional. The default monitoring configuration for all Features with value type (Feature.ValueType) BOOL, STRING, DOUBLE or INT64 under this EntityType.

If this is populated with [FeaturestoreMonitoringConfig.monitoring_interval] specified, snapshot analysis monitoring is enabled. Otherwise, snapshot analysis monitoring is disabled.

Generated from protobuf field .google.cloud.aiplatform.v1.FeaturestoreMonitoringConfig monitoring_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Cloud\AIPlatform\V1\FeaturestoreMonitoringConfig
Returns
TypeDescription
$this