Class Index.IndexField.Builder (3.28.0)

Version latest

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Protobuf type google.firestore.admin.v1.Index.IndexField

Inheritance

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

Implements

Index.IndexFieldOrBuilder

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

build()

public Index.IndexField build()

Returns
Type	Description
Index.IndexField

buildPartial()

public Index.IndexField buildPartial()

Returns
Type	Description
Index.IndexField

clear()

public Index.IndexField.Builder clear()

Returns
Type	Description
Index.IndexField.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearArrayConfig()

public Index.IndexField.Builder clearArrayConfig()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.IndexField.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

clearFieldPath()

public Index.IndexField.Builder clearFieldPath()

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.IndexField.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

clearOrder()

public Index.IndexField.Builder clearOrder()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

clearValueMode()

public Index.IndexField.Builder clearValueMode()

Returns
Type	Description
Index.IndexField.Builder

clearVectorConfig()

public Index.IndexField.Builder clearVectorConfig()

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type	Description
Index.IndexField.Builder

clone()

public Index.IndexField.Builder clone()

Returns
Type	Description
Index.IndexField.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getArrayConfig()

public Index.IndexField.ArrayConfig getArrayConfig()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type	Description
Index.IndexField.ArrayConfig	The arrayConfig.

getArrayConfigValue()

public int getArrayConfigValue()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

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

getDefaultInstanceForType()

public Index.IndexField getDefaultInstanceForType()

Returns
Type	Description
Index.IndexField

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFieldPath()

public String getFieldPath()

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Returns
Type	Description
String	The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Returns
Type	Description
ByteString	The bytes for fieldPath.

getOrder()

public Index.IndexField.Order getOrder()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type	Description
Index.IndexField.Order	The order.

getOrderValue()

public int getOrderValue()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

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

getValueModeCase()

public Index.IndexField.ValueModeCase getValueModeCase()

Returns
Type	Description
Index.IndexField.ValueModeCase

getVectorConfig()

public Index.IndexField.VectorConfig getVectorConfig()

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type	Description
Index.IndexField.VectorConfig	The vectorConfig.

getVectorConfigBuilder()

public Index.IndexField.VectorConfig.Builder getVectorConfigBuilder()

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type	Description
Index.IndexField.VectorConfig.Builder

getVectorConfigOrBuilder()

public Index.IndexField.VectorConfigOrBuilder getVectorConfigOrBuilder()

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type	Description
Index.IndexField.VectorConfigOrBuilder

hasArrayConfig()

public boolean hasArrayConfig()

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns
Type	Description
boolean	Whether the arrayConfig field is set.

hasOrder()

public boolean hasOrder()

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Returns
Type	Description
boolean	Whether the order field is set.

hasVectorConfig()

public boolean hasVectorConfig()

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Returns
Type	Description
boolean	Whether the vectorConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Index.IndexField other)

public Index.IndexField.Builder mergeFrom(Index.IndexField other)

Parameter
Name	Description
other	Index.IndexField

Returns
Type	Description
Index.IndexField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Index.IndexField.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.IndexField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

mergeVectorConfig(Index.IndexField.VectorConfig value)

public Index.IndexField.Builder mergeVectorConfig(Index.IndexField.VectorConfig value)

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Parameter
Name	Description
value	Index.IndexField.VectorConfig

Returns
Type	Description
Index.IndexField.Builder

setArrayConfig(Index.IndexField.ArrayConfig value)

public Index.IndexField.Builder setArrayConfig(Index.IndexField.ArrayConfig value)

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Parameter
Name	Description
value	Index.IndexField.ArrayConfig The arrayConfig to set.

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

setArrayConfigValue(int value)

public Index.IndexField.Builder setArrayConfigValue(int value)

Indicates that this field supports operations on array_values.

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

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

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

setFieldPath(String value)

public Index.IndexField.Builder setFieldPath(String value)

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

Parameter
Name	Description
value	String The fieldPath to set.

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

setFieldPathBytes(ByteString value)

public Index.IndexField.Builder setFieldPathBytes(ByteString value)

Can be name. For single field indexes, this must match the name of the field or may be omitted.

string field_path = 1;

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

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

setOrder(Index.IndexField.Order value)

public Index.IndexField.Builder setOrder(Index.IndexField.Order value)

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

Parameter
Name	Description
value	Index.IndexField.Order The order to set.

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

setOrderValue(int value)

public Index.IndexField.Builder setOrderValue(int value)

Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

.google.firestore.admin.v1.Index.IndexField.Order order = 2;

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

Returns
Type	Description
Index.IndexField.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.IndexField.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Index.IndexField.Builder

Overrides

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

setVectorConfig(Index.IndexField.VectorConfig value)

public Index.IndexField.Builder setVectorConfig(Index.IndexField.VectorConfig value)

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Parameter
Name	Description
value	Index.IndexField.VectorConfig

Returns
Type	Description
Index.IndexField.Builder

setVectorConfig(Index.IndexField.VectorConfig.Builder builderForValue)

public Index.IndexField.Builder setVectorConfig(Index.IndexField.VectorConfig.Builder builderForValue)

Indicates that this field supports nearest neighbor and distance operations on vector.

.google.firestore.admin.v1.Index.IndexField.VectorConfig vector_config = 4;

Parameter
Name	Description
builderForValue	Index.IndexField.VectorConfig.Builder

Returns
Type	Description
Index.IndexField.Builder