Google Cloud Ai Platform V1 Client - Class EntityType (0.15.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
Name	Description
`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.

Returns
Type	Description
`string`

setName

Immutable. Name of the EntityType.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the EntityType.

Returns
Type	Description
`string`

setDescription

Optional. Description of the EntityType.

Parameter
Name	Description
`var`	`string`

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEtag

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

Returns
Type	Description
`string`

setEtag

Optional. 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`

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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\FeaturestoreMonitoringConfig`

Returns
Type	Description
`$this`