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:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class SimulateIndexTemplateRequest
extends RequestBase
implements JsonpSerializable

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

Constructor Summary

Constructors

Constructor	Description
SimulateIndexTemplateRequest(SimulateIndexTemplateRequest.Builder builder)
SimulateIndexTemplateRequest(java.util.function.Function<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	composedOf()	API name: composed_of
java.util.List<java.lang.String>	indexPatterns()	API name: index_patterns
java.lang.String	name()	Required - Index or template name to simulate
java.util.List<OverlappingIndexTemplate>	overlapping()	Any overlapping templates that would have matched, but have lower 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(DelegatingDeserializer<SimulateIndexTemplateRequest.Builder> op)
TemplateMapping	template()	API name: template

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SimulateIndexTemplateRequest> _DESERIALIZER

Json deserializer for SimulateIndexTemplateRequest

ENDPOINT

public static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.simulate_index_template".

Constructor Details

SimulateIndexTemplateRequest

public SimulateIndexTemplateRequest(SimulateIndexTemplateRequest.Builder builder)

SimulateIndexTemplateRequest

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

Method Details

name

public java.lang.String name()

Required - Index or template name to simulate

API name: name

indexPatterns

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

API name: index_patterns

composedOf

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

API name: composed_of

overlapping

@Nullable
public java.util.List<OverlappingIndexTemplate> overlapping()

Any overlapping templates that would have matched, but have lower priority

API name: overlapping

template

@Nullable
public TemplateMapping template()

API name: template

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(DelegatingDeserializer<SimulateIndexTemplateRequest.Builder> op)