Cloud AI Platform v1 API - Class Index (3.3.0) 

public sealed class Index : IMessage<Index>, IEquatable<Index>, IDeepCloneable<Index>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1 API class 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.

Inheritance

object > Index

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

Index()

public Index()

Index(Index)

public Index(Index other)
Parameter
Name Description
other Index

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when this Index was created.

Property Value
Type Description
Timestamp

DeployedIndexes

public RepeatedField<DeployedIndexRef> DeployedIndexes { get; }

Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Property Value
Type Description
RepeatedFieldDeployedIndexRef

Description

public string Description { get; set; }

The description of the Index.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Property Value
Type Description
string

EncryptionSpec

public EncryptionSpec EncryptionSpec { get; set; }

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.

Property Value
Type Description
EncryptionSpec

Etag

public string Etag { get; set; }

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Property Value
Type Description
string

IndexName

public IndexName IndexName { get; set; }

IndexName-typed view over the Name resource name property.

Property Value
Type Description
IndexName

IndexStats

public IndexStats IndexStats { get; set; }

Output only. Stats of the index resource.

Property Value
Type Description
IndexStats

IndexUpdateMethod

public Index.Types.IndexUpdateMethod IndexUpdateMethod { get; set; }

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Property Value
Type Description
IndexTypesIndexUpdateMethod

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Metadata

public Value Metadata { get; set; }

An additional information about the Index; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].

Property Value
Type Description
Value

MetadataSchemaUri

public string MetadataSchemaUri { get; set; }

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.

Property Value
Type Description
string

Name

public string Name { get; set; }

Output only. The resource name of the Index.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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.

Property Value
Type Description
Timestamp