Package co.elastic.clients.elasticsearch.indices

Class SimulateIndexTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.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

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 JsonpDeserializer<SimulateIndexTemplateRequest>	_DESERIALIZER	Json deserializer for SimulateIndexTemplateRequest
static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.simulate_index_template".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowAutoCreate()	API name: allow_auto_create
final List<String>	composedOf()	API name: composed_of
final Boolean	create()	If true, the template passed in the body is only used if no existing templates match the same index patterns.
final DataStreamVisibility	dataStream()	API name: data_stream
final List<String>	indexPatterns()	API name: index_patterns
final Time	masterTimeout()	Period to wait for a connection to the master node.
final Map<String,JsonData>	meta()	API name: _meta
final String	name()	Required - Index or template name to simulate
static SimulateIndexTemplateRequest	of(Function<SimulateIndexTemplateRequest.Builder,ObjectBuilder<SimulateIndexTemplateRequest>> fn)
final 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)
final IndexTemplateMapping	template()	API name: template
final Long	version()	API name: version

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

_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 Details

of

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

meta

public final Map<String,JsonData> meta()

API name: _meta

allowAutoCreate

@Nullable
public final Boolean allowAutoCreate()

API name: allow_auto_create

composedOf

public final List<String> composedOf()

API name: composed_of

create

@Nullable
public final 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 DataStreamVisibility dataStream()

API name: data_stream

indexPatterns

public final List<String> indexPatterns()

API name: index_patterns

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 - Index or template name to simulate

API name: name

priority

@Nullable
public final Integer priority()

API name: priority

template

@Nullable
public final IndexTemplateMapping template()

API name: template

version

@Nullable
public final 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)