- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
Index(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
Attributes
Name | Description |
name |
str
Output only. The resource name of the Index. |
display_name |
str
Required. The display name of the Index. The name can be up to 128 characters long and can be consist of any UTF-8 characters. |
description |
str
The description of the Index. |
metadata_schema_uri |
str
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 |
metadata |
google.protobuf.struct_pb2.Value
An additional information about the Index; the schema of the metadata can be found in metadata_schema. |
deployed_indexes |
Sequence[google.cloud.aiplatform_v1.types.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. |
etag |
str
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
labels |
Mapping[str, str]
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. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Index was created. |
update_time |
google.protobuf.timestamp_pb2.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. |
index_stats |
google.cloud.aiplatform_v1.types.IndexStats
Output only. Stats of the index resource. |
index_update_method |
google.cloud.aiplatform_v1.types.Index.IndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. |
Inheritance
builtins.object > proto.message.Message > IndexClasses
IndexUpdateMethod
IndexUpdateMethod(value)
The update method of an Index.
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |