Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Index (v0.58.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Index.

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

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

#deployed_indexes

def deployed_indexes() -> ::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef>
Returns

#description

def description() -> ::String
Returns
  • (::String) — The description of the Index.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — The description of the Index.
Returns
  • (::String) — The description of the Index.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
Returns
  • (::String) — Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Returns

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
Parameter
Returns

#etag

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

#etag=

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

#index_stats

def index_stats() -> ::Google::Cloud::AIPlatform::V1::IndexStats
Returns

#index_update_method

def index_update_method() -> ::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod
Returns

#index_update_method=

def index_update_method=(value) -> ::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize your Indexes.

    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 and examples of labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize your Indexes.

    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 and examples of labels.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels with user-defined metadata to organize your Indexes.

    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 and examples of labels.

#metadata

def metadata() -> ::Google::Protobuf::Value
Returns

#metadata=

def metadata=(value) -> ::Google::Protobuf::Value
Parameter
Returns

#metadata_schema_uri

def metadata_schema_uri() -> ::String
Returns
  • (::String) — Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

#metadata_schema_uri=

def metadata_schema_uri=(value) -> ::String
Parameter
  • value (::String) — Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
Returns
  • (::String) — Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The resource name of the Index.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.