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
Namespace
Google.Cloud.VectorSearch.V1
Assembly
Google.Cloud.VectorSearch.V1.dll
Constructors
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
DedicatedInfrastructure
public DedicatedInfrastructure DedicatedInfrastructure { get; set; }
Optional. Dedicated infrastructure for the index.
DenseScann
public DenseScannIndex DenseScann { get; set; }
Optional. Dense ScaNN index.
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.
FilterFields
public RepeatedField<string> FilterFields { get; }
Optional. The fields to push into the index to enable fast ANN inline
filtering.
IndexField
public string IndexField { get; set; }
Required. The collection schema field to index.
| Property Value |
| Type |
Description |
string |
|
IndexName
public IndexName IndexName { get; set; }
IndexTypeCase
public Index.IndexTypeOneofCase IndexTypeCase { get; }
InfraTypeCase
public Index.InfraTypeOneofCase InfraTypeCase { get; }
Labels
public MapField<string, string> Labels { get; }
Optional. Labels as key value pairs.
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.
UpdateTime
public Timestamp UpdateTime { get; set; }
Output only. [Output only] Update time stamp
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-02-22 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-02-22 UTC."],[],[]]
