Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Index::IndexField (v1.8.0)

Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index::IndexField.

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#array_config

def array_config() -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig
Returns

#array_config=

def array_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig
Parameter
Returns

#field_path

def field_path() -> ::String
Returns
  • (::String) — Can be name. For single field indexes, this must match the name of the field or may be omitted.

#field_path=

def field_path=(value) -> ::String
Parameter
  • value (::String) — 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.

#order

def order() -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order
Returns
  • (::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order) — Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

    Note: The following fields are mutually exclusive: order, array_config, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#order=

def order=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order
Parameter
  • value (::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order) — Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

    Note: The following fields are mutually exclusive: order, array_config, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order) — Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.

    Note: The following fields are mutually exclusive: order, array_config, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vector_config

def vector_config() -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig
Returns

#vector_config=

def vector_config=(value) -> ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig
Parameter
  • value (::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig) — Indicates that this field supports nearest neighbor and distance operations on vector.

    Note: The following fields are mutually exclusive: vector_config, order, array_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns