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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<SimulateTemplateRequest> static final Endpoint<SimulateTemplateRequest, SimulateTemplateResponse, ErrorResponse> Endpoint "indices.simulate_template". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) builder()final Stringcause()User defined reason for dry-run creating the new template for simulation purposes.final TimeOperation timeout for connection to cluster-manager node.final Booleancreate()Iftrue, the template passed in the body is only used if no existing templates match the same index patterns.protected static JsonpDeserializer<SimulateTemplateRequest> booleaninthashCode()final TimeDeprecated.final Stringname()Name of the index template to simulate.static SimulateTemplateRequestvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final IndexTemplatetemplate()Required - Request body.Create a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
-
_ENDPOINT
public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse, _ENDPOINTErrorResponse> Endpoint "indices.simulate_template".
-
-
Method Details
-
of
public static SimulateTemplateRequest of(Function<SimulateTemplateRequest.Builder, ObjectBuilder<SimulateTemplateRequest>> fn) -
cause
User defined reason for dry-run creating the new template for simulation purposes.API name:
cause -
clusterManagerTimeout
Operation timeout for connection to cluster-manager node.API name:
cluster_manager_timeout -
create
Iftrue, the template passed in the body is only used if no existing templates match the same index patterns. Iffalse, 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.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
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
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<SimulateTemplateRequest.Builder,SimulateTemplateRequest> - Returns:
- a new builder instance.
-
builder
-
createSimulateTemplateRequestDeserializer
protected static JsonpDeserializer<SimulateTemplateRequest> createSimulateTemplateRequestDeserializer() -
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-