com.google.firestore.admin.v1

Class Field.IndexConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

Field.IndexConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Field

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

 The index configuration for this field.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.IndexConfig.Builder The index configuration for this field.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANCESTOR_FIELD_FIELD_NUMBER
static int	INDEXES_FIELD_NUMBER
static int	REVERTING_FIELD_NUMBER
static int	USES_ANCESTOR_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAncestorField() Output only.
com.google.protobuf.ByteString	getAncestorFieldBytes() Output only.
static Field.IndexConfig	getDefaultInstance()
Field.IndexConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Index	getIndexes(int index) 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.
com.google.protobuf.Parser<Field.IndexConfig>	getParserForType()
boolean	getReverting() Output only When true, the `Field`'s index configuration is in the process of being reverted.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUsesAncestorConfig() Output only.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Field.IndexConfig.Builder	newBuilder()
static Field.IndexConfig.Builder	newBuilder(Field.IndexConfig prototype)
Field.IndexConfig.Builder	newBuilderForType()
protected Field.IndexConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Field.IndexConfig	parseDelimitedFrom(InputStream input)
static Field.IndexConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field.IndexConfig	parseFrom(byte[] data)
static Field.IndexConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field.IndexConfig	parseFrom(ByteBuffer data)
static Field.IndexConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field.IndexConfig	parseFrom(com.google.protobuf.ByteString data)
static Field.IndexConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field.IndexConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Field.IndexConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Field.IndexConfig	parseFrom(InputStream input)
static Field.IndexConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Field.IndexConfig>	parser()
Field.IndexConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INDEXES_FIELD_NUMBER

public static final int INDEXES_FIELD_NUMBER

See Also:

Constant Field Values

USES_ANCESTOR_CONFIG_FIELD_NUMBER

public static final int USES_ANCESTOR_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

ANCESTOR_FIELD_FIELD_NUMBER

public static final int ANCESTOR_FIELD_FIELD_NUMBER

See Also:

Constant Field Values

REVERTING_FIELD_NUMBER

public static final int REVERTING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

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

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Field.IndexConfig parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Field.IndexConfig parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static Field.IndexConfig parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field.IndexConfig parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Field.IndexConfig parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static Field.IndexConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Field.IndexConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Field.IndexConfig.Builder newBuilder()

newBuilder

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

toBuilder

public Field.IndexConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Field.IndexConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Field.IndexConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<Field.IndexConfig> parser()

getParserForType

public com.google.protobuf.Parser<Field.IndexConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Field.IndexConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder