2023-08-24 14:03:56 -04:00
|
|
|
---
|
|
|
|
layout: default
|
|
|
|
title: indices
|
|
|
|
parent: Workload reference
|
2023-10-26 15:04:57 -04:00
|
|
|
grand_parent: OpenSearch Benchmark Reference
|
2023-08-24 14:03:56 -04:00
|
|
|
nav_order: 65
|
2023-10-26 15:04:57 -04:00
|
|
|
redirect_from: /benchmark/workloads/indices/
|
2023-08-24 14:03:56 -04:00
|
|
|
---
|
|
|
|
|
2024-01-03 11:30:46 -05:00
|
|
|
<!-- vale off -->
|
2023-08-28 19:09:04 -04:00
|
|
|
# indices
|
2024-01-03 11:30:46 -05:00
|
|
|
<!-- vale on -->
|
2023-08-28 19:09:04 -04:00
|
|
|
|
2023-08-24 14:03:56 -04:00
|
|
|
The `indices` element contains a list of all indices used in the workload.
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
|
|
```json
|
|
|
|
"indices": [
|
|
|
|
{
|
|
|
|
"name": "geonames",
|
|
|
|
"body": "geonames-index.json",
|
|
|
|
}
|
|
|
|
]
|
|
|
|
```
|
|
|
|
|
|
|
|
## Configuration options
|
|
|
|
|
|
|
|
Use the following options with `indices`:
|
|
|
|
|
|
|
|
Parameter | Required | Type | Description
|
|
|
|
:--- | :--- | :--- | :---
|
2023-08-28 19:09:04 -04:00
|
|
|
`name` | Yes | String | The name of the index template.
|
|
|
|
`body` | No | String | The file name corresponding to the index definition used in the body of the Create Index API.
|