Enum StructuredQuery.FieldFilter.Operator (3.15.0)

public enum StructuredQuery.FieldFilter.Operator extends Enum<StructuredQuery.FieldFilter.Operator> implements ProtocolMessageEnum

A field filter operator.

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

Implements

ProtocolMessageEnum

Static Fields

NameDescription
ARRAY_CONTAINS

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

ARRAY_CONTAINS = 7;

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, subject to disjunction limits.
  • No other ARRAY_CONTAINS_ANY filters within the same disjunction.
  • No NOT_IN filters in the same query.

ARRAY_CONTAINS_ANY = 9;

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, subject to disjunction limits.
  • No other ARRAY_CONTAINS_ANY filters within the same disjunction.
  • No NOT_IN filters in the same query.

ARRAY_CONTAINS_ANY = 9;

ARRAY_CONTAINS_VALUE

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

ARRAY_CONTAINS = 7;

EQUAL

The given field is equal to the given value.

EQUAL = 5;

EQUAL_VALUE

The given field is equal to the given value.

EQUAL = 5;

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

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;

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;

GREATER_THAN_VALUE

The given field is greater than the given value.

Requires:

  • That field come first in order_by.

GREATER_THAN = 3;

IN

The given field is equal to at least one value in the given array.

Requires:

  • That value is a non-empty ArrayValue, subject to disjunction limits.
  • No NOT_IN filters in the same query.

IN = 8;

IN_VALUE

The given field is equal to at least one value in the given array.

Requires:

  • That value is a non-empty ArrayValue, subject to disjunction limits.
  • No NOT_IN filters in the same query.

IN = 8;

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

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;

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;

LESS_THAN_VALUE

The given field is less than the given value.

Requires:

  • That field come first in order_by.

LESS_THAN = 1;

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;

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;

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 OR, 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;

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 OR, 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;

OPERATOR_UNSPECIFIED

Unspecified. This value must not be used.

OPERATOR_UNSPECIFIED = 0;

OPERATOR_UNSPECIFIED_VALUE

Unspecified. This value must not be used.

OPERATOR_UNSPECIFIED = 0;

UNRECOGNIZED

Static Methods

NameDescription
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.

valueOf(String name)
values()

Methods

NameDescription
getDescriptorForType()
getNumber()
getValueDescriptor()