Package org.opensearch.client.opensearch.ism

Class AddPolicyRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ism.AddPolicyRequest

All Implemented Interfaces:

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

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

Adds a policy to an index.

Nested Class Summary

Nested Classes

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

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<AddPolicyRequest>	_DESERIALIZER	Json deserializer for AddPolicyRequest
static final Endpoint<AddPolicyRequest,AddPolicyResponse,ErrorResponse>	_ENDPOINT	Endpoint "ism.add_policy".

Method Summary

Modifier and Type	Method	Description
static AddPolicyRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final String	index()	API name: index
static AddPolicyRequest	of(Function<AddPolicyRequest.Builder,ObjectBuilder<AddPolicyRequest>> fn)
final String	policyId()	Required - The ID of the policy to add.
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	setupAddPolicyRequestDeserializer(ObjectDeserializer<AddPolicyRequest.Builder> op)
AddPolicyRequest.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<AddPolicyRequest> _DESERIALIZER

Json deserializer for AddPolicyRequest

_ENDPOINT

public static final Endpoint<AddPolicyRequest,AddPolicyResponse,ErrorResponse> _ENDPOINT

Endpoint "ism.add_policy".

Method Details

of

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

index

@Nullable
public final String index()

API name: index

policyId

@Nonnull
public final String policyId()

Required - The ID of the policy to add.

API name: 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 AddPolicyRequest.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<AddPolicyRequest.Builder,AddPolicyRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static AddPolicyRequest.Builder builder()

setupAddPolicyRequestDeserializer

protected static void setupAddPolicyRequestDeserializer(ObjectDeserializer<AddPolicyRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object