Class Field.IndexConfig.Builder (3.21.0)

Version 3.21.0

• 3.21.3 (latest)
• 3.21.1
• 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 Field.IndexConfig.Builder extends GeneratedMessageV3.Builder<Field.IndexConfig.Builder> implements Field.IndexConfigOrBuilder

The index configuration for this field.

Protobuf type google.firestore.admin.v1.Field.IndexConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Field.IndexConfig.Builder

Implements

Field.IndexConfigOrBuilder

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

addAllIndexes(Iterable<? extends Index> values)

public Field.IndexConfig.Builder addAllIndexes(Iterable<? extends Index> values)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.admin.v1.Index>

Returns
Type	Description
Field.IndexConfig.Builder

addIndexes(Index value)

public Field.IndexConfig.Builder addIndexes(Index value)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
value	Index

Returns
Type	Description
Field.IndexConfig.Builder

addIndexes(Index.Builder builderForValue)

public Field.IndexConfig.Builder addIndexes(Index.Builder builderForValue)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
builderForValue	Index.Builder

Returns
Type	Description
Field.IndexConfig.Builder

addIndexes(int index, Index value)

public Field.IndexConfig.Builder addIndexes(int index, Index value)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameters
Name	Description
index	int
value	Index

Returns
Type	Description
Field.IndexConfig.Builder

addIndexes(int index, Index.Builder builderForValue)

public Field.IndexConfig.Builder addIndexes(int index, Index.Builder builderForValue)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameters
Name	Description
index	int
builderForValue	Index.Builder

Returns
Type	Description
Field.IndexConfig.Builder

addIndexesBuilder()

public Index.Builder addIndexesBuilder()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
Index.Builder

addIndexesBuilder(int index)

public Index.Builder addIndexesBuilder(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Index.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

build()

public Field.IndexConfig build()

Returns
Type	Description
Field.IndexConfig

buildPartial()

public Field.IndexConfig buildPartial()

Returns
Type	Description
Field.IndexConfig

clear()

public Field.IndexConfig.Builder clear()

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAncestorField()

public Field.IndexConfig.Builder clearAncestorField()

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

string ancestor_field = 3;

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Field.IndexConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

clearIndexes()

public Field.IndexConfig.Builder clearIndexes()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
Field.IndexConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Field.IndexConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

clearReverting()

public Field.IndexConfig.Builder clearReverting()

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

bool reverting = 4;

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

clearUsesAncestorConfig()

public Field.IndexConfig.Builder clearUsesAncestorConfig()

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.

bool uses_ancestor_config = 2;

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

clone()

public Field.IndexConfig.Builder clone()

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAncestorField()

public String getAncestorField()

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

string ancestor_field = 3;

Returns
Type	Description
String	The ancestorField.

getAncestorFieldBytes()

public ByteString getAncestorFieldBytes()

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

string ancestor_field = 3;

Returns
Type	Description
ByteString	The bytes for ancestorField.

getDefaultInstanceForType()

public Field.IndexConfig getDefaultInstanceForType()

Returns
Type	Description
Field.IndexConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIndexes(int index)

public Index getIndexes(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Index

getIndexesBuilder(int index)

public Index.Builder getIndexesBuilder(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Index.Builder

getIndexesBuilderList()

public List<Index.Builder> getIndexesBuilderList()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
List<Builder>

getIndexesCount()

public int getIndexesCount()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
int

getIndexesList()

public List<Index> getIndexesList()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
List<Index>

getIndexesOrBuilder(int index)

public IndexOrBuilder getIndexesOrBuilder(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
IndexOrBuilder

getIndexesOrBuilderList()

public List<? extends IndexOrBuilder> getIndexesOrBuilderList()

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Returns
Type	Description
List<? extends com.google.firestore.admin.v1.IndexOrBuilder>

getReverting()

public boolean getReverting()

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

bool reverting = 4;

Returns
Type	Description
boolean	The reverting.

getUsesAncestorConfig()

public boolean getUsesAncestorConfig()

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.

bool uses_ancestor_config = 2;

Returns
Type	Description
boolean	The usesAncestorConfig.

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(Field.IndexConfig other)

public Field.IndexConfig.Builder mergeFrom(Field.IndexConfig other)

Parameter
Name	Description
other	Field.IndexConfig

Returns
Type	Description
Field.IndexConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Field.IndexConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Field.IndexConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Field.IndexConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

removeIndexes(int index)

public Field.IndexConfig.Builder removeIndexes(int index)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Field.IndexConfig.Builder

setAncestorField(String value)

public Field.IndexConfig.Builder setAncestorField(String value)

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

string ancestor_field = 3;

Parameter
Name	Description
value	String The ancestorField to set.

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

setAncestorFieldBytes(ByteString value)

public Field.IndexConfig.Builder setAncestorFieldBytes(ByteString value)

Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).

string ancestor_field = 3;

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

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

setIndexes(int index, Index value)

public Field.IndexConfig.Builder setIndexes(int index, Index value)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameters
Name	Description
index	int
value	Index

Returns
Type	Description
Field.IndexConfig.Builder

setIndexes(int index, Index.Builder builderForValue)

public Field.IndexConfig.Builder setIndexes(int index, Index.Builder builderForValue)

The indexes supported for this field.

repeated .google.firestore.admin.v1.Index indexes = 1;

Parameters
Name	Description
index	int
builderForValue	Index.Builder

Returns
Type	Description
Field.IndexConfig.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

setReverting(boolean value)

public Field.IndexConfig.Builder setReverting(boolean value)

Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.

bool reverting = 4;

Parameter
Name	Description
value	boolean The reverting to set.

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Field.IndexConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Field.IndexConfig.Builder

Overrides

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

setUsesAncestorConfig(boolean value)

public Field.IndexConfig.Builder setUsesAncestorConfig(boolean value)

Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.

bool uses_ancestor_config = 2;

Parameter
Name	Description
value	boolean The usesAncestorConfig to set.

Returns
Type	Description
Field.IndexConfig.Builder	This builder for chaining.