Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::EntityType (v0.8.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the EntityType.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the EntityType.
Returns
  • (::String) — Optional. Description of the EntityType.

#etag

def etag() -> ::String
Returns
  • (::String) — Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Returns
  • (::String) — Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#monitoring_config

def monitoring_config() -> ::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig
Returns
  • (::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.

#monitoring_config=

def monitoring_config=(value) -> ::Google::Cloud::AIPlatform::V1::FeaturestoreMonitoringConfig
Parameter
  • value (::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.

Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns