Class Field.IndexConfig (3.25.1)

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

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException