Class Index.Builder (0.1.0)

public static final class Index.Builder extends GeneratedMessageV3.Builder<Index.Builder> implements IndexOrBuilder

Message describing Index object

Protobuf type google.cloud.vectorsearch.v1beta.Index

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.Builder

Implements

IndexOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllFilterFields(Iterable<String> values)

public Index.Builder addAllFilterFields(Iterable<String> values)

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
values	Iterable<String> The filterFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

addAllStoreFields(Iterable<String> values)

public Index.Builder addAllStoreFields(Iterable<String> values)

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
values	Iterable<String> The storeFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

addFilterFields(String value)

public Index.Builder addFilterFields(String value)

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
value	String The filterFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

addFilterFieldsBytes(ByteString value)

public Index.Builder addFilterFieldsBytes(ByteString value)

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
value	ByteString The bytes of the filterFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addStoreFields(String value)

public Index.Builder addStoreFields(String value)

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
value	String The storeFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

addStoreFieldsBytes(ByteString value)

public Index.Builder addStoreFieldsBytes(ByteString value)

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
value	ByteString The bytes of the storeFields to add.

Returns
Type	Description
Index.Builder	This builder for chaining.

build()

public Index build()

Returns
Type	Description
Index

buildPartial()

public Index buildPartial()

Returns
Type	Description
Index

clear()

public Index.Builder clear()

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCreateTime()

public Index.Builder clearCreateTime()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
Index.Builder

clearDescription()

public Index.Builder clearDescription()

Optional. User-specified description of the index

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

Returns
Type	Description
Index.Builder	This builder for chaining.

clearDisplayName()

public Index.Builder clearDisplayName()

Optional. User-specified display name of the index

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

Returns
Type	Description
Index.Builder	This builder for chaining.

clearDistanceMetric()

public Index.Builder clearDistanceMetric()

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
Index.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterFields()

public Index.Builder clearFilterFields()

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
Index.Builder	This builder for chaining.

clearIndexField()

public Index.Builder clearIndexField()

Required. The collection schema field to index.

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

Returns
Type	Description
Index.Builder	This builder for chaining.

clearLabels()

public Index.Builder clearLabels()

Returns
Type	Description
Index.Builder

clearName()

public Index.Builder clearName()

Identifier. name of resource

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

Returns
Type	Description
Index.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStoreFields()

public Index.Builder clearStoreFields()

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
Index.Builder	This builder for chaining.

clearUpdateTime()

public Index.Builder clearUpdateTime()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
Index.Builder

clone()

public Index.Builder clone()

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. [Output only] Create time stamp

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public 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

getDefaultInstanceForType()

public Index getDefaultInstanceForType()

Returns
Type	Description
Index

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public 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 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList	A list containing the filterFields.

getIndexField()

public 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs.

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

Returns
Type	Description
int

getLabelsMap()

public 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 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 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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

Identifier. name of resource

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

Returns
Type	Description
String	The name.

getNameBytes()

public 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 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 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 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 ProtocolStringList 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
ProtocolStringList	A list containing the storeFields.

getUpdateTime()

public 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. [Output only] Update time stamp

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Index.Builder mergeCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Index.Builder

mergeFrom(Index other)

public Index.Builder mergeFrom(Index other)

Parameter
Name	Description
other	Index

Returns
Type	Description
Index.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Index.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Index.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Index.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Index.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Index.Builder mergeUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Index.Builder

putAllLabels(Map<String,String> values)

public Index.Builder putAllLabels(Map<String,String> values)

Optional. Labels as key value pairs.

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

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
Index.Builder

putLabels(String key, String value)

public Index.Builder putLabels(String key, String value)

Optional. Labels as key value pairs.

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

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
Index.Builder

removeLabels(String key)

public Index.Builder removeLabels(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
Index.Builder

setCreateTime(Timestamp value)

public Index.Builder setCreateTime(Timestamp value)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Index.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Index.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Create time stamp

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Index.Builder

setDescription(String value)

public Index.Builder setDescription(String value)

Optional. User-specified description of the index

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public Index.Builder setDescriptionBytes(ByteString value)

Optional. User-specified description of the index

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

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setDisplayName(String value)

public Index.Builder setDisplayName(String value)

Optional. User-specified display name of the index

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

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Index.Builder setDisplayNameBytes(ByteString value)

Optional. User-specified display name of the index

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

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setDistanceMetric(DistanceMetric value)

public Index.Builder setDistanceMetric(DistanceMetric value)

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];

Parameter
Name	Description
value	DistanceMetric The distanceMetric to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setDistanceMetricValue(int value)

public Index.Builder setDistanceMetricValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for distanceMetric to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterFields(int index, String value)

public Index.Builder setFilterFields(int index, String value)

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

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

Parameters
Name	Description
index	int The index to set the value at.
value	String The filterFields to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setIndexField(String value)

public Index.Builder setIndexField(String value)

Required. The collection schema field to index.

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

Parameter
Name	Description
value	String The indexField to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setIndexFieldBytes(ByteString value)

public Index.Builder setIndexFieldBytes(ByteString value)

Required. The collection schema field to index.

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

Parameter
Name	Description
value	ByteString The bytes for indexField to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setName(String value)

public Index.Builder setName(String value)

Identifier. name of resource

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Index.Builder setNameBytes(ByteString value)

Identifier. name of resource

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Index.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStoreFields(int index, String value)

public Index.Builder setStoreFields(int index, String value)

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

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

Parameters
Name	Description
index	int The index to set the value at.
value	String The storeFields to set.

Returns
Type	Description
Index.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Index.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Index.Builder setUpdateTime(Timestamp value)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
Index.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Index.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. [Output only] Update time stamp

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Index.Builder