Class: Google::Firestore::Admin::V1::Index::IndexField
- Inherits:
-
Object
- Object
- Google::Firestore::Admin::V1::Index::IndexField
- Defined in:
- lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb
Overview
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
Defined Under Namespace
Modules: ArrayConfig, Order
Instance Attribute Summary collapse
-
#array_config ⇒ Google::Firestore::Admin::V1::Index::IndexField::ArrayConfig
Indicates that this field supports operations on
array_value
s. -
#field_path ⇒ String
Can be name.
-
#order ⇒ Google::Firestore::Admin::V1::Index::IndexField::Order
Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
Instance Attribute Details
#array_config ⇒ Google::Firestore::Admin::V1::Index::IndexField::ArrayConfig
Returns Indicates that this field supports operations on array_value
s.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb', line 69 class IndexField # The supported array value configurations. module ArrayConfig # The index does not support additional array queries. ARRAY_CONFIG_UNSPECIFIED = 0 # The index supports array containment queries. CONTAINS = 1 end # The supported orderings. module Order # The ordering is unspecified. Not a valid option. ORDER_UNSPECIFIED = 0 # The field is ordered by ascending field value. ASCENDING = 1 # The field is ordered by descending field value. DESCENDING = 2 end end |
#field_path ⇒ String
Returns Can be name. For single field indexes, this must match the name of the field or may be omitted.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb', line 69 class IndexField # The supported array value configurations. module ArrayConfig # The index does not support additional array queries. ARRAY_CONFIG_UNSPECIFIED = 0 # The index supports array containment queries. CONTAINS = 1 end # The supported orderings. module Order # The ordering is unspecified. Not a valid option. ORDER_UNSPECIFIED = 0 # The field is ordered by ascending field value. ASCENDING = 1 # The field is ordered by descending field value. DESCENDING = 2 end end |
#order ⇒ Google::Firestore::Admin::V1::Index::IndexField::Order
Returns Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/cloud/firestore/admin/v1/doc/google/firestore/admin/v1/index.rb', line 69 class IndexField # The supported array value configurations. module ArrayConfig # The index does not support additional array queries. ARRAY_CONFIG_UNSPECIFIED = 0 # The index supports array containment queries. CONTAINS = 1 end # The supported orderings. module Order # The ordering is unspecified. Not a valid option. ORDER_UNSPECIFIED = 0 # The field is ordered by ascending field value. ASCENDING = 1 # The field is ordered by descending field value. DESCENDING = 2 end end |