Vision AI V1 API - Class Google::Cloud::VisionAI::V1::IndexEndpoint (v0.1.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::IndexEndpoint.

Message representing IndexEndpoint resource. Indexes are deployed into it.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

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

#deployed_index

def deployed_index() -> ::Google::Cloud::VisionAI::V1::DeployedIndex
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
Returns
  • (::String) — Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
Returns
  • (::String) — Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    See Google Cloud Document for more details.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}

#state

def state() -> ::Google::Cloud::VisionAI::V1::IndexEndpoint::State
Returns

#update_time

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