Class: Google::Firestore::V1beta1::StructuredQuery::FieldFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb

Overview

A filter on a specific field.

Defined Under Namespace

Modules: Operator

Instance Attribute Summary collapse

Instance Attribute Details

#field ⇒ Google::Firestore::V1beta1::StructuredQuery::FieldReference

Returns The field to filter by.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb', line 121

class FieldFilter
  # A field filter operator.
  module Operator
    # Unspecified. This value must not be used.
    OPERATOR_UNSPECIFIED = 0

    # Less than. Requires that the field come first in `order_by`.
    LESS_THAN = 1

    # Less than or equal. Requires that the field come first in `order_by`.
    LESS_THAN_OR_EQUAL = 2

    # Greater than. Requires that the field come first in `order_by`.
    GREATER_THAN = 3

    # Greater than or equal. Requires that the field come first in
    # `order_by`.
    GREATER_THAN_OR_EQUAL = 4

    # Equal.
    EQUAL = 5

    # Contains. Requires that the field is an array.
    ARRAY_CONTAINS = 7

    # In. Requires that `value` is a non-empty ArrayValue with at most 10
    # values.
    IN = 8

    # Contains any. Requires that the field is an array and
    # `value` is a non-empty ArrayValue with at most 10 values.
    ARRAY_CONTAINS_ANY = 9
  end
end

#op ⇒ Google::Firestore::V1beta1::StructuredQuery::FieldFilter::Operator

Returns The operator to filter by.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb', line 121

class FieldFilter
  # A field filter operator.
  module Operator
    # Unspecified. This value must not be used.
    OPERATOR_UNSPECIFIED = 0

    # Less than. Requires that the field come first in `order_by`.
    LESS_THAN = 1

    # Less than or equal. Requires that the field come first in `order_by`.
    LESS_THAN_OR_EQUAL = 2

    # Greater than. Requires that the field come first in `order_by`.
    GREATER_THAN = 3

    # Greater than or equal. Requires that the field come first in
    # `order_by`.
    GREATER_THAN_OR_EQUAL = 4

    # Equal.
    EQUAL = 5

    # Contains. Requires that the field is an array.
    ARRAY_CONTAINS = 7

    # In. Requires that `value` is a non-empty ArrayValue with at most 10
    # values.
    IN = 8

    # Contains any. Requires that the field is an array and
    # `value` is a non-empty ArrayValue with at most 10 values.
    ARRAY_CONTAINS_ANY = 9
  end
end

#value ⇒ Google::Firestore::V1beta1::Value

Returns The value to compare to.

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb', line 121

class FieldFilter
  # A field filter operator.
  module Operator
    # Unspecified. This value must not be used.
    OPERATOR_UNSPECIFIED = 0

    # Less than. Requires that the field come first in `order_by`.
    LESS_THAN = 1

    # Less than or equal. Requires that the field come first in `order_by`.
    LESS_THAN_OR_EQUAL = 2

    # Greater than. Requires that the field come first in `order_by`.
    GREATER_THAN = 3

    # Greater than or equal. Requires that the field come first in
    # `order_by`.
    GREATER_THAN_OR_EQUAL = 4

    # Equal.
    EQUAL = 5

    # Contains. Requires that the field is an array.
    ARRAY_CONTAINS = 7

    # In. Requires that `value` is a non-empty ArrayValue with at most 10
    # values.
    IN = 8

    # Contains any. Requires that the field is an array and
    # `value` is a non-empty ArrayValue with at most 10 values.
    ARRAY_CONTAINS_ANY = 9
  end
end