Send feedback
Class Field.IndexConfig (3.9.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.9.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
Static Fields
ANCESTOR_FIELD_FIELD_NUMBER
public static final int ANCESTOR_FIELD_FIELD_NUMBER
Field Value
INDEXES_FIELD_NUMBER
public static final int INDEXES_FIELD_NUMBER
Field Value
REVERTING_FIELD_NUMBER
public static final int REVERTING_FIELD_NUMBER
Field Value
USES_ANCESTOR_CONFIG_FIELD_NUMBER
public static final int USES_ANCESTOR_CONFIG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Field . IndexConfig getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Field . IndexConfig . Builder newBuilder ()
Returns
newBuilder(Field.IndexConfig prototype)
public static Field . IndexConfig . Builder newBuilder ( Field . IndexConfig prototype )
Parameter
Returns
public static Field . IndexConfig parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Field . IndexConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Field . IndexConfig parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Field . IndexConfig parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Field . IndexConfig parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Field . IndexConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Field . IndexConfig parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Field . IndexConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Field . IndexConfig parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Field . IndexConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Field . IndexConfig > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
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
getIndexes(int index)
public Index getIndexes ( int index )
The indexes supported for this field.
repeated .google.firestore.admin.v1.Index indexes = 1;
Parameter
Returns
getIndexesCount()
public int getIndexesCount ()
The indexes supported for this field.
repeated .google.firestore.admin.v1.Index indexes = 1;
Returns
getIndexesList()
public List<Index> getIndexesList ()
The indexes supported for this field.
repeated .google.firestore.admin.v1.Index indexes = 1;
Returns
getIndexesOrBuilder(int index)
public IndexOrBuilder getIndexesOrBuilder ( int index )
The indexes supported for this field.
repeated .google.firestore.admin.v1.Index indexes = 1;
Parameter
Returns
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
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Field . IndexConfig . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Field . IndexConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Field . IndexConfig . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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."],[],[]]
