Package co.elastic.clients.elasticsearch.indices

Class SimulateIndexTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest

public class SimulateIndexTemplateRequest
extends RequestBase

Simulate an index. Get the index configuration that would be applied to the specified index from an existing index template.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimulateIndexTemplateRequest.Builder	Builder for SimulateIndexTemplateRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.simulate_index_template".

Method Summary

Modifier and Type	Method	Description
final Boolean	includeDefaults()	If true, returns all relevant default configurations for the index template.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	Required - Name of the index to simulate
static SimulateIndexTemplateRequest	of(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

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

Endpoint "indices.simulate_index_template".

Method Details

of

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

includeDefaults

@Nullable
public final Boolean includeDefaults()

If true, returns all relevant default configurations for the index template.

API name: include_defaults

masterTimeout

@Nullable
public final Time masterTimeout()

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

name

public final String name()

Required - Name of the index to simulate

API name: name