- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.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
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this Index was created.
#deployed_indexes
def deployed_indexes() -> ::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef>
- (::Array<::Google::Cloud::AIPlatform::V1::DeployedIndexRef>) — Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
#description
def description() -> ::String
- (::String) — The description of the Index.
#description=
def description=(value) -> ::String
- value (::String) — The description of the Index.
- (::String) — The description of the Index.
#display_name
def display_name() -> ::String
- (::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
- 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.
- (::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.
#etag
def etag() -> ::String
- (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
#etag=
def etag=(value) -> ::String
- value (::String) — Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
- (::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
- (::Google::Cloud::AIPlatform::V1::IndexStats) — Output only. Stats of the index resource.
#index_update_method
def index_update_method() -> ::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod
- (::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod) — Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
#index_update_method=
def index_update_method=(value) -> ::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod
- value (::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod) — Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
- (::Google::Cloud::AIPlatform::V1::Index::IndexUpdateMethod) — Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::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}
-
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.
-
(::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
- (::Google::Protobuf::Value) — An additional information about the Index; the schema of the metadata can be found in metadata_schema.
#metadata=
def metadata=(value) -> ::Google::Protobuf::Value
- value (::Google::Protobuf::Value) — An additional information about the Index; the schema of the metadata can be found in metadata_schema.
- (::Google::Protobuf::Value) — An additional information about the Index; the schema of the metadata can be found in metadata_schema.
#metadata_schema_uri
def metadata_schema_uri() -> ::String
- (::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
- 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.
- (::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
- (::String) — Output only. The resource name of the Index.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::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.