Note: The following fields are mutually exclusive: array_config, order, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: array_config, order, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: array_config, order, vector_config. If a field in that set is populated, all other fields in the set will automatically be cleared.
#field_path
deffield_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=
deffield_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.
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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::Index::IndexField (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-Index-IndexField)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-Index-IndexField) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::Index::IndexField.\n\nA field in an index.\nThe field_path describes which field is indexed, the value_mode describes\nhow the field value is indexed. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #array_config\n\n def array_config() -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig\n\n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-ArrayConfig)) --- Indicates that this field supports operations on `array_value`s.\n\n\n Note: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #array_config=\n\n def array_config=(value) -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-ArrayConfig)) --- Indicates that this field supports operations on `array_value`s.\n\n\nNote: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-ArrayConfig)) --- Indicates that this field supports operations on `array_value`s.\n\n\n Note: The following fields are mutually exclusive: `array_config`, `order`, `vector_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #field_path\n\n def field_path() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Can be **name**. For single field indexes, this must match the name of the field or may be omitted.\n\n### #field_path=\n\n def field_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Can be **name**. For single field indexes, this must match the name of the field or may be omitted. \n**Returns**\n\n- (::String) --- Can be **name**. For single field indexes, this must match the name of the field or may be omitted.\n\n### #order\n\n def order() -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order\n\n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-Order)) --- Indicates that this field supports ordering by the specified order or comparing using =, !=, \\\u003c, \\\u003c=, \\\u003e, \\\u003e=.\n\n\n 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.\n\n### #order=\n\n def order=(value) -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-Order)) --- Indicates that this field supports ordering by the specified order or comparing using =, !=, \\\u003c, \\\u003c=, \\\u003e, \\\u003e=.\n\n\nNote: 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. \n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-Order)) --- Indicates that this field supports ordering by the specified order or comparing using =, !=, \\\u003c, \\\u003c=, \\\u003e, \\\u003e=.\n\n\n 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.\n\n### #vector_config\n\n def vector_config() -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig\n\n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)) --- Indicates that this field supports nearest neighbor and distance operations on vector.\n\n\n 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.\n\n### #vector_config=\n\n def vector_config=(value) -\u003e ::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)) --- Indicates that this field supports nearest neighbor and distance operations on vector.\n\n\nNote: 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. \n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Index::IndexField::VectorConfig](./Google-Cloud-Firestore-Admin-V1-Index-IndexField-VectorConfig)) --- Indicates that this field supports nearest neighbor and distance operations on vector.\n\n\n 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."]]