Package org.opensearch.client.opensearch.ism

Class ChangePolicyRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ism.ChangePolicyRequest

All Implemented Interfaces:

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

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

Updates the managed index policy to a new policy.

Nested Class Summary

Nested Classes

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

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<ChangePolicyRequest>	_DESERIALIZER	Json deserializer for ChangePolicyRequest
static final Endpoint<ChangePolicyRequest,ChangePolicyResponse,ErrorResponse>	_ENDPOINT	Endpoint "ism.change_policy".

Method Summary

Modifier and Type	Method	Description
static ChangePolicyRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final List<IncludeState>	include()	The states to include in the policy change.
final String	index()	API name: index
static ChangePolicyRequest	of(Function<ChangePolicyRequest.Builder,ObjectBuilder<ChangePolicyRequest>> fn)
final String	policyId()	Required - The ID of the new policy.
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	setupChangePolicyRequestDeserializer(ObjectDeserializer<ChangePolicyRequest.Builder> op)
final String	state()	The state to transition to.
ChangePolicyRequest.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<ChangePolicyRequest> _DESERIALIZER

Json deserializer for ChangePolicyRequest

_ENDPOINT

public static final Endpoint<ChangePolicyRequest,ChangePolicyResponse,ErrorResponse> _ENDPOINT

Endpoint "ism.change_policy".

Method Details

of

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

include

@Nonnull
public final List<IncludeState> include()

The states to include in the policy change.

API name: include

index

@Nullable
public final String index()

API name: index

policyId

@Nonnull
public final String policyId()

Required - The ID of the new policy.

API name: policy_id

state

@Nullable
public final String state()

The state to transition to.

API name: state

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

Returns:

a new builder instance.

builder

@Nonnull
public static ChangePolicyRequest.Builder builder()

setupChangePolicyRequestDeserializer

protected static void setupChangePolicyRequestDeserializer(ObjectDeserializer<ChangePolicyRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object