com.google.firestore.v1

Enum StructuredQuery.FieldFilter.Operator

java.lang.Object

java.lang.Enum<StructuredQuery.FieldFilter.Operator>

com.google.firestore.v1.StructuredQuery.FieldFilter.Operator

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<StructuredQuery.FieldFilter.Operator>

Enclosing class:

StructuredQuery.FieldFilter

public static enum StructuredQuery.FieldFilter.Operator
extends Enum<StructuredQuery.FieldFilter.Operator>
implements com.google.protobuf.ProtocolMessageEnum

 A field filter operator.
 

Protobuf enum google.firestore.v1.StructuredQuery.FieldFilter.Operator

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY_CONTAINS The given `field` is an array that contains the given `value`.
ARRAY_CONTAINS_ANY The given `field` is an array that contains any of the values in the given array.
EQUAL The given `field` is equal to the given `value`.
GREATER_THAN The given `field` is greater than the given `value`.
GREATER_THAN_OR_EQUAL The given `field` is greater than or equal to the given `value`.
IN The given `field` is equal to at least one value in the given array.
LESS_THAN The given `field` is less than the given `value`.
LESS_THAN_OR_EQUAL The given `field` is less than or equal to the given `value`.
NOT_EQUAL The given `field` is not equal to the given `value`.
NOT_IN The value of the `field` is not in the given array.
OPERATOR_UNSPECIFIED Unspecified.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY_CONTAINS_ANY_VALUE The given `field` is an array that contains any of the values in the given array.
static int	ARRAY_CONTAINS_VALUE The given `field` is an array that contains the given `value`.
static int	EQUAL_VALUE The given `field` is equal to the given `value`.
static int	GREATER_THAN_OR_EQUAL_VALUE The given `field` is greater than or equal to the given `value`.
static int	GREATER_THAN_VALUE The given `field` is greater than the given `value`.
static int	IN_VALUE The given `field` is equal to at least one value in the given array.
static int	LESS_THAN_OR_EQUAL_VALUE The given `field` is less than or equal to the given `value`.
static int	LESS_THAN_VALUE The given `field` is less than the given `value`.
static int	NOT_EQUAL_VALUE The given `field` is not equal to the given `value`.
static int	NOT_IN_VALUE The value of the `field` is not in the given array.
static int	OPERATOR_UNSPECIFIED_VALUE Unspecified.

Method Summary

Modifier and Type	Method and Description
static StructuredQuery.FieldFilter.Operator	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<StructuredQuery.FieldFilter.Operator>	internalGetValueMap()
static StructuredQuery.FieldFilter.Operator	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static StructuredQuery.FieldFilter.Operator	valueOf(int value) Deprecated. Use forNumber(int) instead.
static StructuredQuery.FieldFilter.Operator	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructuredQuery.FieldFilter.Operator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPERATOR_UNSPECIFIED

public static final StructuredQuery.FieldFilter.Operator OPERATOR_UNSPECIFIED

 Unspecified. This value must not be used.
 

OPERATOR_UNSPECIFIED = 0;

LESS_THAN

public static final StructuredQuery.FieldFilter.Operator LESS_THAN

 The given `field` is less than the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

LESS_THAN = 1;

LESS_THAN_OR_EQUAL

public static final StructuredQuery.FieldFilter.Operator LESS_THAN_OR_EQUAL

 The given `field` is less than or equal to the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

LESS_THAN_OR_EQUAL = 2;

GREATER_THAN

public static final StructuredQuery.FieldFilter.Operator GREATER_THAN

 The given `field` is greater than the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

GREATER_THAN = 3;

GREATER_THAN_OR_EQUAL

public static final StructuredQuery.FieldFilter.Operator GREATER_THAN_OR_EQUAL

 The given `field` is greater than or equal to the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

GREATER_THAN_OR_EQUAL = 4;

EQUAL

public static final StructuredQuery.FieldFilter.Operator EQUAL

 The given `field` is equal to the given `value`.
 

EQUAL = 5;

NOT_EQUAL

public static final StructuredQuery.FieldFilter.Operator NOT_EQUAL

 The given `field` is not equal to the given `value`.
 Requires:
 * No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
 * That `field` comes first in the `order_by`.
 

NOT_EQUAL = 6;

ARRAY_CONTAINS

public static final StructuredQuery.FieldFilter.Operator ARRAY_CONTAINS

 The given `field` is an array that contains the given `value`.
 

ARRAY_CONTAINS = 7;

IN

public static final StructuredQuery.FieldFilter.Operator IN

 The given `field` is equal to at least one value in the given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
 

IN = 8;

ARRAY_CONTAINS_ANY

public static final StructuredQuery.FieldFilter.Operator ARRAY_CONTAINS_ANY

 The given `field` is an array that contains any of the values in the
 given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
 

ARRAY_CONTAINS_ANY = 9;

NOT_IN

public static final StructuredQuery.FieldFilter.Operator NOT_IN

 The value of the `field` is not in the given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
   `IS_NOT_NULL`, or `IS_NOT_NAN`.
 * That `field` comes first in the `order_by`.
 

NOT_IN = 10;

UNRECOGNIZED

public static final StructuredQuery.FieldFilter.Operator UNRECOGNIZED

Field Detail

OPERATOR_UNSPECIFIED_VALUE

public static final int OPERATOR_UNSPECIFIED_VALUE

 Unspecified. This value must not be used.
 

OPERATOR_UNSPECIFIED = 0;

See Also:

Constant Field Values

LESS_THAN_VALUE

public static final int LESS_THAN_VALUE

 The given `field` is less than the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

LESS_THAN = 1;

See Also:

Constant Field Values

LESS_THAN_OR_EQUAL_VALUE

public static final int LESS_THAN_OR_EQUAL_VALUE

 The given `field` is less than or equal to the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

LESS_THAN_OR_EQUAL = 2;

See Also:

Constant Field Values

GREATER_THAN_VALUE

public static final int GREATER_THAN_VALUE

 The given `field` is greater than the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

GREATER_THAN = 3;

See Also:

Constant Field Values

GREATER_THAN_OR_EQUAL_VALUE

public static final int GREATER_THAN_OR_EQUAL_VALUE

 The given `field` is greater than or equal to the given `value`.
 Requires:
 * That `field` come first in `order_by`.
 

GREATER_THAN_OR_EQUAL = 4;

See Also:

Constant Field Values

EQUAL_VALUE

public static final int EQUAL_VALUE

 The given `field` is equal to the given `value`.
 

EQUAL = 5;

See Also:

Constant Field Values

NOT_EQUAL_VALUE

public static final int NOT_EQUAL_VALUE

 The given `field` is not equal to the given `value`.
 Requires:
 * No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
 * That `field` comes first in the `order_by`.
 

NOT_EQUAL = 6;

See Also:

Constant Field Values

ARRAY_CONTAINS_VALUE

public static final int ARRAY_CONTAINS_VALUE

 The given `field` is an array that contains the given `value`.
 

ARRAY_CONTAINS = 7;

See Also:

Constant Field Values

IN_VALUE

public static final int IN_VALUE

 The given `field` is equal to at least one value in the given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
 

IN = 8;

See Also:

Constant Field Values

ARRAY_CONTAINS_ANY_VALUE

public static final int ARRAY_CONTAINS_ANY_VALUE

 The given `field` is an array that contains any of the values in the
 given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
 

ARRAY_CONTAINS_ANY = 9;

See Also:

Constant Field Values

NOT_IN_VALUE

public static final int NOT_IN_VALUE

 The value of the `field` is not in the given array.
 Requires:
 * That `value` is a non-empty `ArrayValue` with at most 10 values.
 * No other `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
   `IS_NOT_NULL`, or `IS_NOT_NAN`.
 * That `field` comes first in the `order_by`.
 

NOT_IN = 10;

See Also:

Constant Field Values

Method Detail

values

public static StructuredQuery.FieldFilter.Operator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StructuredQuery.FieldFilter.Operator c : StructuredQuery.FieldFilter.Operator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StructuredQuery.FieldFilter.Operator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static StructuredQuery.FieldFilter.Operator valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static StructuredQuery.FieldFilter.Operator forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<StructuredQuery.FieldFilter.Operator> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static StructuredQuery.FieldFilter.Operator valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)