com.google.firestore.admin.v1

Class Field.IndexConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

com.google.firestore.admin.v1.Field.IndexConfig.Builder

All Implemented Interfaces:

Field.IndexConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Field.IndexConfig

public static final class Field.IndexConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>
implements Field.IndexConfigOrBuilder

 The index configuration for this field.
 

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

Method Summary

Modifier and Type	Method and Description
Field.IndexConfig.Builder	addAllIndexes(Iterable<? extends Index> values) The indexes supported for this field.
Field.IndexConfig.Builder	addIndexes(Index.Builder builderForValue) The indexes supported for this field.
Field.IndexConfig.Builder	addIndexes(Index value) The indexes supported for this field.
Field.IndexConfig.Builder	addIndexes(int index, Index.Builder builderForValue) The indexes supported for this field.
Field.IndexConfig.Builder	addIndexes(int index, Index value) The indexes supported for this field.
Index.Builder	addIndexesBuilder() The indexes supported for this field.
Index.Builder	addIndexesBuilder(int index) The indexes supported for this field.
Field.IndexConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Field.IndexConfig	build()
Field.IndexConfig	buildPartial()
Field.IndexConfig.Builder	clear()
Field.IndexConfig.Builder	clearAncestorField() Output only.
Field.IndexConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Field.IndexConfig.Builder	clearIndexes() The indexes supported for this field.
Field.IndexConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Field.IndexConfig.Builder	clearReverting() Output only When true, the `Field`'s index configuration is in the process of being reverted.
Field.IndexConfig.Builder	clearUsesAncestorConfig() Output only.
Field.IndexConfig.Builder	clone()
String	getAncestorField() Output only.
com.google.protobuf.ByteString	getAncestorFieldBytes() Output only.
Field.IndexConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Index	getIndexes(int index) The indexes supported for this field.
Index.Builder	getIndexesBuilder(int index) The indexes supported for this field.
List<Index.Builder>	getIndexesBuilderList() The indexes supported for this field.
int	getIndexesCount() The indexes supported for this field.
List<Index>	getIndexesList() The indexes supported for this field.
IndexOrBuilder	getIndexesOrBuilder(int index) The indexes supported for this field.
List<? extends IndexOrBuilder>	getIndexesOrBuilderList() The indexes supported for this field.
boolean	getReverting() Output only When true, the `Field`'s index configuration is in the process of being reverted.
boolean	getUsesAncestorConfig() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Field.IndexConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Field.IndexConfig.Builder	mergeFrom(Field.IndexConfig other)
Field.IndexConfig.Builder	mergeFrom(com.google.protobuf.Message other)
Field.IndexConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Field.IndexConfig.Builder	removeIndexes(int index) The indexes supported for this field.
Field.IndexConfig.Builder	setAncestorField(String value) Output only.
Field.IndexConfig.Builder	setAncestorFieldBytes(com.google.protobuf.ByteString value) Output only.
Field.IndexConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Field.IndexConfig.Builder	setIndexes(int index, Index.Builder builderForValue) The indexes supported for this field.
Field.IndexConfig.Builder	setIndexes(int index, Index value) The indexes supported for this field.
Field.IndexConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Field.IndexConfig.Builder	setReverting(boolean value) Output only When true, the `Field`'s index configuration is in the process of being reverted.
Field.IndexConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Field.IndexConfig.Builder	setUsesAncestorConfig(boolean value) Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

clear

public Field.IndexConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

getDefaultInstanceForType

public Field.IndexConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Field.IndexConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Field.IndexConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Field.IndexConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

clearField

public Field.IndexConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

clearOneof

public Field.IndexConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

mergeFrom

public Field.IndexConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.IndexConfig.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

mergeFrom

public Field.IndexConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.IndexConfig.Builder>

Throws:

IOException

getIndexesList

public List<Index> getIndexesList()

 The indexes supported for this field.
 

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

Specified by:

getIndexesList in interface Field.IndexConfigOrBuilder

getIndexesCount

public int getIndexesCount()

 The indexes supported for this field.
 

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

Specified by:

getIndexesCount in interface Field.IndexConfigOrBuilder

getIndexes

public Index getIndexes(int index)

 The indexes supported for this field.
 

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

Specified by:

getIndexes in interface Field.IndexConfigOrBuilder

setIndexes

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

 The indexes supported for this field.
 

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

setIndexes

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

 The indexes supported for this field.
 

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

addIndexes

public Field.IndexConfig.Builder addIndexes(Index value)

 The indexes supported for this field.
 

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

addIndexes

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

 The indexes supported for this field.
 

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

addIndexes

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

 The indexes supported for this field.
 

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

addIndexes

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

 The indexes supported for this field.
 

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

addAllIndexes

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

 The indexes supported for this field.
 

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

clearIndexes

public Field.IndexConfig.Builder clearIndexes()

 The indexes supported for this field.
 

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

removeIndexes

public Field.IndexConfig.Builder removeIndexes(int index)

 The indexes supported for this field.
 

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

getIndexesBuilder

public Index.Builder getIndexesBuilder(int index)

 The indexes supported for this field.
 

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

getIndexesOrBuilder

public IndexOrBuilder getIndexesOrBuilder(int index)

 The indexes supported for this field.
 

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

Specified by:

getIndexesOrBuilder in interface Field.IndexConfigOrBuilder

getIndexesOrBuilderList

public List<? extends IndexOrBuilder> getIndexesOrBuilderList()

 The indexes supported for this field.
 

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

Specified by:

getIndexesOrBuilderList in interface Field.IndexConfigOrBuilder

addIndexesBuilder

public Index.Builder addIndexesBuilder()

 The indexes supported for this field.
 

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

addIndexesBuilder

public Index.Builder addIndexesBuilder(int index)

 The indexes supported for this field.
 

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

getIndexesBuilderList

public List<Index.Builder> getIndexesBuilderList()

 The indexes supported for this field.
 

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

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;

Specified by:

getUsesAncestorConfig in interface Field.IndexConfigOrBuilder

Returns:

The usesAncestorConfig.

setUsesAncestorConfig

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;

Parameters:

value - The usesAncestorConfig to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getAncestorField in interface Field.IndexConfigOrBuilder

Returns:

The ancestorField.

getAncestorFieldBytes

public com.google.protobuf.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;

Specified by:

getAncestorFieldBytes in interface Field.IndexConfigOrBuilder

Returns:

The bytes for ancestorField.

setAncestorField

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;

Parameters:

value - The ancestorField to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setAncestorFieldBytes

public Field.IndexConfig.Builder setAncestorFieldBytes(com.google.protobuf.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;

Parameters:

value - The bytes for ancestorField to set.

Returns:

This builder for chaining.

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;

Specified by:

getReverting in interface Field.IndexConfigOrBuilder

Returns:

The reverting.

setReverting

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;

Parameters:

value - The reverting to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final Field.IndexConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>

mergeUnknownFields

public final Field.IndexConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.IndexConfig.Builder>