Package org.opensearch.client.opensearch.indices

Class SimulateIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.SimulateIndexTemplateRequest

All Implemented Interfaces:

ToJsonp

public final class SimulateIndexTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SimulateIndexTemplateRequest>	DESERIALIZER	Json deserializer for SimulateIndexTemplateRequest
static Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.simulate_index_template".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimulateIndexTemplateRequest(SimulateIndexTemplateRequest.Builder builder)

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()	Index or template name to simulate API name: name
java.util.List<OverlappingIndexTemplate>	overlapping()	Any overlapping templates that would have matched, but have lower priority API name: overlapping
protected static void	setupSimulateIndexTemplateRequestDeserializer(DelegatingDeserializer<SimulateIndexTemplateRequest.Builder> op)
TemplateMapping	template()	API name: template
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

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,OpenSearchError> ENDPOINT

Endpoint "indices.simulate_index_template".

Constructor Details

SimulateIndexTemplateRequest

protected SimulateIndexTemplateRequest(SimulateIndexTemplateRequest.Builder builder)

Method Details

name

@Nullable public java.lang.String name()

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

toJsonp

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

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupSimulateIndexTemplateRequestDeserializer

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