Package org.opensearch.client.opensearch.ism

Class ExplainPolicyRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ism.ExplainPolicyRequest

All Implemented Interfaces:

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

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

Retrieves the currently applied policy on the specified indexes.

Nested Class Summary

Nested Classes

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

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<ExplainPolicyRequest>	_DESERIALIZER
static final Endpoint<ExplainPolicyRequest,ExplainPolicyResponse,ErrorResponse>	_ENDPOINT	Endpoint "ism.explain_policy".

Method Summary

Modifier and Type	Method	Description
final JsonData	body()	Required - Request body.
static ExplainPolicyRequest.Builder	builder()
protected static JsonpDeserializer<ExplainPolicyRequest>	createExplainPolicyRequestDeserializer()
boolean	equals(Object o)
int	hashCode()
final String	index()	API name: index
static ExplainPolicyRequest	of(Function<ExplainPolicyRequest.Builder,ObjectBuilder<ExplainPolicyRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
ExplainPolicyRequest.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

applyQueryParameters, 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<ExplainPolicyRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<ExplainPolicyRequest,ExplainPolicyResponse,ErrorResponse> _ENDPOINT

Endpoint "ism.explain_policy".

Method Details

of

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

body

@Nonnull
public final JsonData body()

Required - Request body.

index

@Nullable
public final String index()

API name: index

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 ExplainPolicyRequest.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<ExplainPolicyRequest.Builder,ExplainPolicyRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ExplainPolicyRequest.Builder builder()

createExplainPolicyRequestDeserializer

protected static JsonpDeserializer<ExplainPolicyRequest> createExplainPolicyRequestDeserializer()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object