REST Resource: projects.locations.indexes

Stay organized with collections Save and categorize content based on your preferences.

Resource: 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.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "metadataSchemaUri": string,
  "metadata": value,
  "deployedIndexes": [
    {
      object (DeployedIndexRef)
    }
  ],
  "etag": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "indexStats": {
    object (IndexStats)
  },
  "indexUpdateMethod": enum (IndexUpdateMethod)
}
Fields
name

string

Output only. The resource name of the Index.

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.

description

string

The description of the Index.

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.

metadata

value (Value format)

An additional information about the Index; the schema of the metadata can be found in metadataSchema.

deployedIndexes[]

object (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

string

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