# IndexOptions

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Reference](https://developer.m-files.com/APIs/gRPC-API/Reference/index.md) > [Messages](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.IndexOptions/

Options of one index within the vault.

- **Full name:** `MFiles.IndexOptions`
- **Proto file:** [`mfiles/structs.proto`](https://developer.m-files.com/APIs/gRPC-API/downloads/proto/mfiles/structs.proto)

<a id="fields"></a>

## Fields

| Field | Type | Number | Description |
|---|---|---|---|
| <a id="f-name"></a>`name` | [`IndexName`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.IndexName/index.md) | 1 | The name of the index. |
| <a id="f-data_type"></a>`data_type` | [`IndexedDataType`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.IndexedDataType/index.md) | 2 | The type of the data the indexer can index. Values: `INDEXED_DATA_TYPE_UNSPECIFIED` (0), `INDEXED_DATA_TYPE_METADATA` (1), `INDEXED_DATA_TYPE_FILE_DATA` (2), `INDEXED_DATA_TYPE_COMBINED` (3). |
| <a id="f-search_engine"></a>`search_engine` | [`SearchEngine`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.SearchEngine/index.md) | 3 | Identifies the search engine. Values: `SEARCH_ENGINE_UNSPECIFIED` (0), `SEARCH_ENGINE_DT_SEARCH` (1), `SEARCH_ENGINE_IDOL` (2), `SEARCH_ENGINE_AZURE_SEARCH` (3), `SEARCH_ENGINE_SMART_SEARCH` (4), `SEARCH_ENGINE_AINO_SEARCH` (5), `SEARCH_ENGINE_GOLDFISH` (6). |
| <a id="f-enabled_in_storage"></a>`enabled_in_storage` | [`IndexEnabled`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.IndexEnabled/index.md) | 4 | The enabled status of the index in the current storage. |
| <a id="f-enabled_effective"></a>`enabled_effective` | [`IndexEnabled`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.IndexEnabled/index.md) | 5 | The effective enabled status. |
| <a id="f-active"></a>`active` | `bool` | 6 | True, if the index is set as an active index. |
| <a id="f-multi_repository"></a>`multi_repository` | `bool` | 7 | True, if the physical index can contain multiple repositories. |
| <a id="f-notifications"></a>`notifications` | [`INDEXNOTIFICATIONFLAGS`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.INDEXNOTIFICATIONFLAGS/index.md) | 8 | Specifies notifications of the given index. |
| <a id="f-exists_implicitly"></a>`exists_implicitly` | `bool` | 9 | True, if the index exists implicitly. For example, if the index is default index that exists regardless of configuration. |
| <a id="f-allowed_operations"></a>`allowed_operations` | [`IndexManagementOperationArray`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.IndexManagementOperationArray/index.md) | 10 | Operations user is allowed to perform with this index. |

<a id="used-by-methods"></a>

## Used by methods

- [IRPCVaultAdmin.GetIndexOptions](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultAdmin/GetIndexOptions/index.md): Lists the search indexes of the vault with their state and the management operations the caller may run on each.

<a id="used-in-fields"></a>

## Used in fields

- [`GetIndexOptionsResponse.index_options`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCVaultAdmin/GetIndexOptions/index.md#response): One item per index: its name, the data it indexes, the search engine, whether it is enabled and active, and the operations the caller may run on it.