Send feedback
Class Field.IndexConfig (3.21.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.21.1 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Field . IndexConfig . Builder newBuilder ()
newBuilder(Field.IndexConfig prototype)
public static Field . IndexConfig . Builder newBuilder ( Field . IndexConfig prototype )
public static Field . IndexConfig parseDelimitedFrom ( InputStream input )
public static Field . IndexConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Field . IndexConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Field . IndexConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Field . IndexConfig parseFrom ( CodedInputStream input )
public static Field . IndexConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Field . IndexConfig parseFrom ( InputStream input )
public static Field . IndexConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Field . IndexConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Field . IndexConfig > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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 ()
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
indexint
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;
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
indexint
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 ()
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Field . IndexConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Field . IndexConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Field . IndexConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
