Class Field.IndexConfig

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

Fields

ANCESTOR_FIELD_FIELD_NUMBER

public static final int ANCESTOR_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

INDEXES_FIELD_NUMBER

public static final int INDEXES_FIELD_NUMBER
Field Value
TypeDescription
int

REVERTING_FIELD_NUMBER

public static final int REVERTING_FIELD_NUMBER
Field Value
TypeDescription
int

USES_ANCESTOR_CONFIG_FIELD_NUMBER

public static final int USES_ANCESTOR_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

getDefaultInstance()

public static Field.IndexConfig getDefaultInstance()
Returns
TypeDescription
Field.IndexConfig

getDefaultInstanceForType()

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

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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

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>

getParserForType()

public Parser<Field.IndexConfig> getParserForType()
Returns
TypeDescription
Parser<IndexConfig>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Field.IndexConfig.Builder newBuilder()
Returns
TypeDescription
Field.IndexConfig.Builder

newBuilder(Field.IndexConfig prototype)

public static Field.IndexConfig.Builder newBuilder(Field.IndexConfig prototype)
Parameter
NameDescription
prototypeField.IndexConfig
Returns
TypeDescription
Field.IndexConfig.Builder

newBuilderForType()

public Field.IndexConfig.Builder newBuilderForType()
Returns
TypeDescription
Field.IndexConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.IndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Field.IndexConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Field.IndexConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Field.IndexConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field.IndexConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field.IndexConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Field.IndexConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Field.IndexConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field.IndexConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.IndexConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Field.IndexConfig> parser()
Returns
TypeDescription
Parser<IndexConfig>

toBuilder()

public Field.IndexConfig.Builder toBuilder()
Returns
TypeDescription
Field.IndexConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException