com.google.firestore.admin.v1

Interface Index.IndexFieldOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Index.IndexField, Index.IndexField.Builder

Enclosing class:

Index

public static interface Index.IndexFieldOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Index.IndexField.ArrayConfig	getArrayConfig() Indicates that this field supports operations on `array_value`s.
int	getArrayConfigValue() Indicates that this field supports operations on `array_value`s.
String	getFieldPath() Can be __name__.
com.google.protobuf.ByteString	getFieldPathBytes() Can be __name__.
Index.IndexField.Order	getOrder() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
int	getOrderValue() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
Index.IndexField.ValueModeCase	getValueModeCase()
boolean	hasArrayConfig() Indicates that this field supports operations on `array_value`s.
boolean	hasOrder() Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFieldPath

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:

The fieldPath.

getFieldPathBytes

com.google.protobuf.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:

The bytes for fieldPath.

hasOrder

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:

Whether the order field is set.

getOrderValue

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:

The enum numeric value on the wire for order.

getOrder

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:

The order.

hasArrayConfig

boolean hasArrayConfig()

 Indicates that this field supports operations on `array_value`s.
 

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns:

Whether the arrayConfig field is set.

getArrayConfigValue

int getArrayConfigValue()

 Indicates that this field supports operations on `array_value`s.
 

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns:

The enum numeric value on the wire for arrayConfig.

getArrayConfig

Index.IndexField.ArrayConfig getArrayConfig()

 Indicates that this field supports operations on `array_value`s.
 

.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;

Returns:

The arrayConfig.

getValueModeCase

Index.IndexField.ValueModeCase getValueModeCase()