IndexOptions

View as Markdown

Options of one index within the vault.

Full name	`MFiles.IndexOptions`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`name`	`IndexName`	1	The name of the index.
`data_type`	`IndexedDataType`	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).
`search_engine`	`SearchEngine`	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).
`enabled_in_storage`	`IndexEnabled`	4	The enabled status of the index in the current storage.
`enabled_effective`	`IndexEnabled`	5	The effective enabled status.
`active`	`bool`	6	True, if the index is set as an active index.
`multi_repository`	`bool`	7	True, if the physical index can contain multiple repositories.
`notifications`	`INDEXNOTIFICATIONFLAGS`	8	Specifies notifications of the given index.
`exists_implicitly`	`bool`	9	True, if the index exists implicitly. For example, if the index is default index that exists regardless of configuration.
`allowed_operations`	`IndexManagementOperationArray`	10	Operations user is allowed to perform with this index.

Used by methods

IRPCVaultAdmin.GetIndexOptions -- Lists the search indexes of the vault with their state and the management operations the caller may run on each.

Used in fields

GetIndexOptionsResponse.index_options -- 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.