Index class final

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

Inheritance

Constructors

Index({String name = '', required String displayName, String description = '', String metadataSchemaUri = '', Value? metadata, List<DeployedIndexRef> deployedIndexes = const [], String etag = '', Map<String, String> labels = const {}, Timestamp? createTime, Timestamp? updateTime, IndexStats? indexStats, Index_IndexUpdateMethod indexUpdateMethod = Index_IndexUpdateMethod.$default, EncryptionSpec? encryptionSpec, bool satisfiesPzs = false, bool satisfiesPzi = false})
Index.fromJson(Object? j)
factory

Properties

createTime → Timestamp?
Output only. Timestamp when this Index was created.
final
deployedIndexes → List<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.
final
description → String
The description of the Index.
final
displayName → 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.
final
encryptionSpec → EncryptionSpec?
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key.
final
etag → String
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
final
hashCode → int
The hash code for this object.
no setterinherited
indexStats → IndexStats?
Output only. Stats of the index resource.
final
indexUpdateMethod → Index_IndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
final
labels → Map<String, String>
The labels with user-defined metadata to organize your Indexes.
final
metadata → Value?
An additional information about the Index; the schema of the metadata can be found in metadata_schema.
final
metadataSchemaUri → 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.
final
name → String
Output only. The resource name of the Index.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzi → bool
Output only. Reserved for future use.
final
satisfiesPzs → bool
Output only. Reserved for future use.
final
updateTime → 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.v1beta1.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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String