SimulateIndexTemplateRequest (rest-high-level 1.3.8 API)

java.lang.Object
- org.opensearch.client.TimedRequest
- - org.opensearch.client.indices.SimulateIndexTemplateRequest

All Implemented Interfaces:

Validatable
```
public class SimulateIndexTemplateRequest
extends TimedRequest
```
A request to simulate matching a provided index name and an optional new index template against the existing index templates.

Field Summary
- Fields inherited from class org.opensearch.client.TimedRequest
  DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
- Fields inherited from interface org.opensearch.client.Validatable
  EMPTY

Constructor Summary

Constructors
Constructor Description

SimulateIndexTemplateRequest(java.lang.String indexName)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`indexName()`	Return the index name for which we simulate the index template matching.
`SimulateIndexTemplateRequest`	`indexName(java.lang.String indexName)`	Set the index name to simulate template matching against the index templates in the system.
`PutComposableIndexTemplateRequest`	`indexTemplateV2Request()`	An optional new template request will be part of the index template simulation.
`SimulateIndexTemplateRequest`	`indexTemplateV2Request(PutComposableIndexTemplateRequest indexTemplateV2Request)`	Optionally, define a new template request which will included in the index simulation as if it was an index template stored in the system.

Methods inherited from class org.opensearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.Validatable
validate

- Constructor Detail
  - SimulateIndexTemplateRequest
```
public SimulateIndexTemplateRequest(java.lang.String indexName)
```
- Method Detail
  - indexName
```
public java.lang.String indexName()
```
    Return the index name for which we simulate the index template matching.
  - indexName
```
public SimulateIndexTemplateRequest indexName(java.lang.String indexName)
```
    Set the index name to simulate template matching against the index templates in the system.
  - indexTemplateV2Request
```
@Nullable
public PutComposableIndexTemplateRequest indexTemplateV2Request()
```
    An optional new template request will be part of the index template simulation.
  - indexTemplateV2Request
```
public SimulateIndexTemplateRequest indexTemplateV2Request(@Nullable
                                                           PutComposableIndexTemplateRequest indexTemplateV2Request)
```
    Optionally, define a new template request which will included in the index simulation as if it was an index template stored in the system. The new template will be validated just as a regular, standalone, live, new index template request.