Class Field.IndexConfig.Builder (3.2.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.firestore.admin.v1.Index>
Returns
TypeDescription
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
NameDescription
valueIndex
Returns
TypeDescription
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
NameDescription
builderForValueIndex.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueIndex
Returns
TypeDescription
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
NameDescription
indexint
builderForValueIndex.Builder
Returns
TypeDescription
Field.IndexConfig.Builder

addIndexesBuilder()

public Index.Builder addIndexesBuilder()

The indexes supported for this field.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Index.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Field.IndexConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

build()

public Field.IndexConfig build()
Returns
TypeDescription
Field.IndexConfig

buildPartial()

public Field.IndexConfig buildPartial()
Returns
TypeDescription
Field.IndexConfig

clear()

public Field.IndexConfig.Builder clear()
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
TypeDescription
Field.IndexConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Field.IndexConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

clearIndexes()

public Field.IndexConfig.Builder clearIndexes()

The indexes supported for this field.

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

Returns
TypeDescription
Field.IndexConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Field.IndexConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
TypeDescription
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
TypeDescription
Field.IndexConfig.Builder

This builder for chaining.

clone()

public Field.IndexConfig.Builder clone()
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for ancestorField.

getDefaultInstanceForType()

public Field.IndexConfig getDefaultInstanceForType()
Returns
TypeDescription
Field.IndexConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIndexes(int index)

public Index getIndexes(int index)

The indexes supported for this field.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Index.Builder

getIndexesBuilderList()

public List<Index.Builder> getIndexesBuilderList()

The indexes supported for this field.

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

Returns
TypeDescription
List<Builder>

getIndexesCount()

public int getIndexesCount()

The indexes supported for this field.

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

Returns
TypeDescription
int

getIndexesList()

public List<Index> getIndexesList()

The indexes supported for this field.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
IndexOrBuilder

getIndexesOrBuilderList()

public List<? extends IndexOrBuilder> getIndexesOrBuilderList()

The indexes supported for this field.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The usesAncestorConfig.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Field.IndexConfig other)

public Field.IndexConfig.Builder mergeFrom(Field.IndexConfig other)
Parameter
NameDescription
otherField.IndexConfig
Returns
TypeDescription
Field.IndexConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Field.IndexConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Field.IndexConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Field.IndexConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueString

The ancestorField to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for ancestorField to set.

Returns
TypeDescription
Field.IndexConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Field.IndexConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
NameDescription
indexint
valueIndex
Returns
TypeDescription
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
NameDescription
indexint
builderForValueIndex.Builder
Returns
TypeDescription
Field.IndexConfig.Builder

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

public Field.IndexConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
NameDescription
valueboolean

The reverting to set.

Returns
TypeDescription
Field.IndexConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Field.IndexConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

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
NameDescription
valueboolean

The usesAncestorConfig to set.

Returns
TypeDescription
Field.IndexConfig.Builder

This builder for chaining.