Class Field.IndexConfig (3.0.21)

Version 3.0.21

• 3.30.2 (latest)
• 3.30.0
• 3.28.0
• 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 Field.IndexConfig extends GeneratedMessageV3 implements Field.IndexConfigOrBuilder

The index configuration for this field.

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

Inheritance

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

Implements

Field.IndexConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ANCESTOR_FIELD_FIELD_NUMBER

public static final int ANCESTOR_FIELD_FIELD_NUMBER

Field Value

Type	Description
int

INDEXES_FIELD_NUMBER

public static final int INDEXES_FIELD_NUMBER

Field Value

Type	Description
int

REVERTING_FIELD_NUMBER

public static final int REVERTING_FIELD_NUMBER

Field Value

Type	Description
int

USES_ANCESTOR_CONFIG_FIELD_NUMBER

public static final int USES_ANCESTOR_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static Field.IndexConfig getDefaultInstance()

Returns

Type	Description
Field.IndexConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static Field.IndexConfig.Builder newBuilder()

Returns

Type	Description
Field.IndexConfig.Builder

newBuilder(Field.IndexConfig prototype)

public static Field.IndexConfig.Builder newBuilder(Field.IndexConfig prototype)

Parameter

Name	Description
prototype	Field.IndexConfig

Returns

Type	Description
Field.IndexConfig.Builder

parseDelimitedFrom(InputStream input)

public static Field.IndexConfig parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static Field.IndexConfig parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field.IndexConfig parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field.IndexConfig parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static Field.IndexConfig parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static Field.IndexConfig parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Field.IndexConfig

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Field.IndexConfig> parser()

Returns

Type	Description
Parser<IndexConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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

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>

getParserForType()

public Parser<Field.IndexConfig> getParserForType()

Returns

Type	Description
Parser<IndexConfig>

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Field.IndexConfig.Builder newBuilderForType()

Returns

Type	Description
Field.IndexConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.IndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
Field.IndexConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Field.IndexConfig.Builder toBuilder()

Returns

Type	Description
Field.IndexConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException