Package org.opensearch.client.opensearch.indices

Class SimulateTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.SimulateTemplateRequest

All Implemented Interfaces:

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

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

Simulate resolving the given template name or body.

Nested Class Summary

Nested Classes

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

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<SimulateTemplateRequest>	_DESERIALIZER
static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.simulate_template".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static SimulateTemplateRequest.Builder	builder()
final String	cause()	User defined reason for dry-run creating the new template for simulation purposes.
final Time	clusterManagerTimeout()	Operation timeout for connection to cluster-manager node.
final Boolean	create()	If true, the template passed in the body is only used if no existing templates match the same index patterns.
protected static JsonpDeserializer<SimulateTemplateRequest>	createSimulateTemplateRequestDeserializer()
boolean	equals(Object o)
int	hashCode()
final Time	masterTimeout()	Deprecated.
final String	name()	Name of the index template to simulate.
static SimulateTemplateRequest	of(Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final IndexTemplate	template()	Required - Request body.
SimulateTemplateRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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<SimulateTemplateRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.simulate_template".

Method Details

of

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

cause

@Nullable
public final String cause()

User defined reason for dry-run creating the new template for simulation purposes.

API name: cause

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

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

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

name

@Nullable
public final String name()

Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

API name: name

template

@Nonnull
public final IndexTemplate template()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public SimulateTemplateRequest.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<SimulateTemplateRequest.Builder,SimulateTemplateRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static SimulateTemplateRequest.Builder builder()

createSimulateTemplateRequestDeserializer

protected static JsonpDeserializer<SimulateTemplateRequest> createSimulateTemplateRequestDeserializer()

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