java.lang.Object
- org.opensearch.client.opensearch._types.RequestBase
- - org.opensearch.client.opensearch.indices.SimulateIndexTemplateRequest

All Implemented Interfaces:

JsonpSerializable
```
@JsonpDeserializable
public class SimulateIndexTemplateRequest
extends RequestBase
implements JsonpSerializable
```
Simulate matching the given index name against the index templates in the system

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SimulateIndexTemplateRequest.Builder
Builder for SimulateIndexTemplateRequest.
- Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
  RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<SimulateIndexTemplateRequest>`	`_DESERIALIZER`	Json deserializer for `SimulateIndexTemplateRequest`
`static Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`indices.simulate_index_template`".

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`java.lang.Boolean`	`allowAutoCreate()`	API name: `allow_auto_create`
`Time`	`clusterManagerTimeout()`	Period to wait for a connection to the cluster-manager node.
`java.util.List<java.lang.String>`	`composedOf()`	API name: `composed_of`
`java.lang.Boolean`	`create()`	If `true`, the template passed in the body is only used if no existing templates match the same index patterns.
`DataStream`	`dataStream()`	API name: `data_stream`
`java.util.List<java.lang.String>`	`indexPatterns()`	API name: `index_patterns`
`Time`	`masterTimeout()`	Deprecated.
`java.util.Map<java.lang.String,JsonData>`	`meta()`	API name: `_meta`
`java.lang.String`	`name()`	Required - Index or template name to simulate
`static SimulateIndexTemplateRequest`	`of(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)`
`java.lang.Integer`	`priority()`	API name: `priority`
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)`
`IndexTemplateMapping`	`template()`	API name: `template`
`java.lang.Long`	`version()`	API name: `version`

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SimulateIndexTemplateRequest> _DESERIALIZER

Json deserializer for SimulateIndexTemplateRequest

_ENDPOINT

public static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.simulate_index_template".

Method Detail

of

public static SimulateIndexTemplateRequest of(java.util.function.Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)

allowAutoCreate

@Nullable
public final java.lang.Boolean allowAutoCreate()

API name: allow_auto_create

composedOf

public final java.util.List<java.lang.String> composedOf()

API name: composed_of

create
```
@Nullable
public final java.lang.Boolean create()
```
If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.
API name: create

dataStream

@Nullable
public final DataStream dataStream()

API name: data_stream

indexPatterns

public final java.util.List<java.lang.String> indexPatterns()

API name: index_patterns

masterTimeout
```
@Deprecated
@Nullable
public final Time masterTimeout()
```
Deprecated.

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
API name: master_timeout

clusterManagerTimeout
```
@Nullable
public final Time clusterManagerTimeout()
```
Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
API name: cluster_manager_timeout

name
```
public final java.lang.String name()
```
Required - Index or template name to simulate
API name: name

priority

@Nullable
public final java.lang.Integer priority()

API name: priority

template

@Nullable
public final IndexTemplateMapping template()

API name: template

version

@Nullable
public final java.lang.Long version()

API name: version

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:: serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupSimulateIndexTemplateRequestDeserializer

protected static void setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)

Class SimulateIndexTemplateRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase