Vector Search v1 API - Class Index (1.0.0-beta01)

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

Reference documentation and code samples for the Vector Search v1 API class Index.

Message describing Index object

Inheritance

object > Index

Implements

IMessageIndex, IEquatableIndex, IDeepCloneableIndex, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.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. [Output only] Create time stamp

Property Value
Type	Description
Timestamp

DedicatedInfrastructure

public DedicatedInfrastructure DedicatedInfrastructure { get; set; }

Optional. Dedicated infrastructure for the index.

Property Value
Type	Description
DedicatedInfrastructure

DenseScann

public DenseScannIndex DenseScann { get; set; }

Optional. Dense ScaNN index.

Property Value
Type	Description
DenseScannIndex

Description

public string Description { get; set; }

Optional. User-specified description of the index

Property Value
Type	Description
string

DisplayName

public string DisplayName { get; set; }

Optional. User-specified display name of the index

Property Value
Type	Description
string

DistanceMetric

public DistanceMetric DistanceMetric { get; set; }

Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.

Property Value
Type	Description
DistanceMetric

FilterFields

public RepeatedField<string> FilterFields { get; }

Optional. The fields to push into the index to enable fast ANN inline filtering.

Property Value
Type	Description
RepeatedFieldstring

IndexField

public string IndexField { get; set; }

Required. The collection schema field to index.

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

IndexTypeCase

public Index.IndexTypeOneofCase IndexTypeCase { get; }

Property Value
Type	Description
IndexIndexTypeOneofCase

InfraTypeCase

public Index.InfraTypeOneofCase InfraTypeCase { get; }

Property Value
Type	Description
IndexInfraTypeOneofCase

Labels

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

Optional. Labels as key value pairs.

Property Value
Type	Description
MapFieldstringstring

Name

public string Name { get; set; }

Identifier. name of resource

Property Value
Type	Description
string

StoreFields

public RepeatedField<string> StoreFields { get; }

Optional. The fields to push into the index to enable inline data retrieval.

Property Value
Type	Description
RepeatedFieldstring

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. [Output only] Update time stamp

Property Value
Type	Description
Timestamp