Send feedback
Class Index.IndexField (3.8.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.8.0 keyboard_arrow_down
public static final class Index . IndexField extends GeneratedMessageV3 implements Index . IndexFieldOrBuilder
A field in an index.
The field_path describes which field is indexed, the value_mode describes
how the field value is indexed.
Protobuf type google.firestore.admin.v1.Index.IndexField
Static Fields
ARRAY_CONFIG_FIELD_NUMBER
public static final int ARRAY_CONFIG_FIELD_NUMBER
Field Value
FIELD_PATH_FIELD_NUMBER
public static final int FIELD_PATH_FIELD_NUMBER
Field Value
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Index . IndexField getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Index . IndexField . Builder newBuilder ()
Returns
newBuilder(Index.IndexField prototype)
public static Index . IndexField . Builder newBuilder ( Index . IndexField prototype )
Parameter
Returns
public static Index . IndexField parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Index . IndexField parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Index . IndexField parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Index . IndexField parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Index . IndexField parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Index . IndexField parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Index . IndexField parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Index . IndexField parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Index . IndexField parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Index . IndexField parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Index . IndexField parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Index . IndexField parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Index . IndexField > parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getArrayConfig()
public Index . IndexField . ArrayConfig getArrayConfig ()
Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
Returns
getArrayConfigValue()
public int getArrayConfigValue ()
Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
Returns
Type Description int The enum numeric value on the wire for arrayConfig.
getDefaultInstanceForType()
public Index . IndexField getDefaultInstanceForType ()
Returns
getFieldPath()
public String getFieldPath ()
Can be name .
For single field indexes, this must match the name of the field or may
be omitted.
string field_path = 1;
Returns
Type Description String The fieldPath.
getFieldPathBytes()
public ByteString getFieldPathBytes ()
Can be name .
For single field indexes, this must match the name of the field or may
be omitted.
string field_path = 1;
Returns
getOrder()
public Index . IndexField . Order getOrder ()
Indicates that this field supports ordering by the specified order or
comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
Returns
getOrderValue()
public int getOrderValue ()
Indicates that this field supports ordering by the specified order or
comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
Returns
Type Description int The enum numeric value on the wire for order.
getParserForType()
public Parser<Index . IndexField > getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
getValueModeCase()
public Index . IndexField . ValueModeCase getValueModeCase ()
Returns
hasArrayConfig()
public boolean hasArrayConfig ()
Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
Returns
Type Description boolean Whether the arrayConfig field is set.
hasOrder()
public boolean hasOrder ()
Indicates that this field supports ordering by the specified order or
comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
Returns
Type Description boolean Whether the order field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Index . IndexField . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Index . IndexField . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Index . IndexField . 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."],[],[]]
