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:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class SimulateIndexTemplateRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>

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 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()	This setting overrides the value of the action.auto_create_index cluster setting.
protected void	applyQueryParameters(Map<String,String> params)
static SimulateIndexTemplateRequest.Builder	builder()
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
final List<String>	composedOf()	An ordered list of component template names.
final IndexTemplateDataStreamConfiguration	dataStream()	API name: data_stream
boolean	equals(Object o)
int	hashCode()
final List<String>	indexPatterns()	API name: index_patterns
final Time	masterTimeout()	Deprecated.
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()	Priority to determine index template precedence when a new data stream or index is created.
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
SimulateIndexTemplateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Long	version()	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

allowAutoCreate

@Nullable
public final Boolean allowAutoCreate()

This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indexes can be automatically created using that template even if auto-creation of indexes is disabled using actions.auto_create_index. If set to false, then indexes or data streams matching the template must always be explicitly created, and may never be automatically created.

API name: allow_auto_create

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

composedOf

@Nonnull
public final List<String> composedOf()

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

dataStream

@Nullable
public final IndexTemplateDataStreamConfiguration dataStream()

API name: data_stream

indexPatterns

@Nonnull
public final List<String> indexPatterns()

API name: index_patterns

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

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: master_timeout

meta

@Nonnull
public final Map<String,JsonData> meta()

API name: _meta

name

@Nonnull
public final String name()

Required - Index or template name to simulate

API name: name

priority

@Nullable
public final Integer priority()

Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch.

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)

toBuilder

@Nonnull
public SimulateIndexTemplateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SimulateIndexTemplateRequest.Builder builder()

setupSimulateIndexTemplateRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object