Class: Google::Cloud::Firestore::Admin::V1::Index::IndexField

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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

Instance Attribute Details

#array_config::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig

Returns Indicates that this field supports operations on array_values.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'proto_docs/google/firestore/admin/v1/index.rb', line 77

class IndexField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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

  # 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
end

#field_path::String

Returns Can be name. For single field indexes, this must match the name of the field or may be omitted.

Returns:

  • (::String)

    Can be name. For single field indexes, this must match the name of the field or may be omitted.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'proto_docs/google/firestore/admin/v1/index.rb', line 77

class IndexField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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

  # 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
end

#order::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order

Returns Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'proto_docs/google/firestore/admin/v1/index.rb', line 77

class IndexField
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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

  # 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
end