Interface IndexOrBuilder (0.1.0)

public interface IndexOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. User-specified description of the index

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. User-specified description of the index

string description = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Optional. User-specified display name of the index

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. User-specified display name of the index

string display_name = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for displayName.

getDistanceMetric()

public abstract DistanceMetric getDistanceMetric()

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

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DistanceMetric	The distanceMetric.

getDistanceMetricValue()

public abstract int getDistanceMetricValue()

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

.google.cloud.vectorsearch.v1beta.DistanceMetric distance_metric = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for distanceMetric.

getFilterFields(int index)

public abstract String getFilterFields(int index)

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

repeated string filter_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The filterFields at the given index.

getFilterFieldsBytes(int index)

public abstract ByteString getFilterFieldsBytes(int index)

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

repeated string filter_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the filterFields at the given index.

getFilterFieldsCount()

public abstract int getFilterFieldsCount()

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

repeated string filter_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of filterFields.

getFilterFieldsList()

public abstract List<String> getFilterFieldsList()

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

repeated string filter_fields = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the filterFields.

getIndexField()

public abstract String getIndexField()

Required. The collection schema field to index.

string index_field = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The indexField.

getIndexFieldBytes()

public abstract ByteString getIndexFieldBytes()

Required. The collection schema field to index.

string index_field = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for indexField.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels as key value pairs.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels as key value pairs.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels as key value pairs.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels as key value pairs.

map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Identifier. name of resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. name of resource

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getStoreFields(int index)

public abstract String getStoreFields(int index)

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

repeated string store_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The storeFields at the given index.

getStoreFieldsBytes(int index)

public abstract ByteString getStoreFieldsBytes(int index)

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

repeated string store_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the storeFields at the given index.

getStoreFieldsCount()

public abstract int getStoreFieldsCount()

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

repeated string store_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of storeFields.

getStoreFieldsList()

public abstract List<String> getStoreFieldsList()

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

repeated string store_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the storeFields.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. [Output only] Create time stamp

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. [Output only] Update time stamp

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.