Package org.opensearch.client.opensearch.ism

Class ExplainPolicy

java.lang.Object

org.opensearch.client.opensearch.ism.ExplainPolicy

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ExplainPolicy>	_DESERIALIZER	Json deserializer for ExplainPolicy

Method Summary

Modifier and Type	Method	Description
static ExplainPolicy.Builder	builder()
final Boolean	enabled()	Whether the policy is enabled for the index.
boolean	equals(Object o)
int	hashCode()
final String	indexOpendistroIndexStateManagementPolicyId()	The ID of the OpenDistro policy applied to the index.
final String	indexPluginsIndexStateManagementPolicyId()	The ID of the policy applied to the index.
static ExplainPolicy	of(Function<ExplainPolicy.Builder,ObjectBuilder<ExplainPolicy>> fn)
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	setupExplainPolicyDeserializer(ObjectDeserializer<ExplainPolicy.Builder> op)
ExplainPolicy.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

Json deserializer for ExplainPolicy

Method Details

of

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

enabled

@Nullable
public final Boolean enabled()

Whether the policy is enabled for the index.

API name: enabled

indexOpendistroIndexStateManagementPolicyId

@Nullable
public final String indexOpendistroIndexStateManagementPolicyId()

The ID of the OpenDistro policy applied to the index.

API name: index.opendistro.index_state_management.policy_id

indexPluginsIndexStateManagementPolicyId

@Nullable
public final String indexPluginsIndexStateManagementPolicyId()

The ID of the policy applied to the index.

API name: index.plugins.index_state_management.policy_id

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

Returns:

a new builder instance.

builder

@Nonnull
public static ExplainPolicy.Builder builder()

setupExplainPolicyDeserializer

protected static void setupExplainPolicyDeserializer(ObjectDeserializer<ExplainPolicy.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object