Package org.opensearch.client.opensearch.ism

Class PutPolicyRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ism.PutPolicyRequest

All Implemented Interfaces:

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

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

Creates or updates a policy.

Nested Class Summary

Nested Classes

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

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<PutPolicyRequest>	_DESERIALIZER	Json deserializer for PutPolicyRequest
static final Endpoint<PutPolicyRequest,PutPolicyResponse,ErrorResponse>	_ENDPOINT	Endpoint "ism.put_policy".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PutPolicyRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Number	ifPrimaryTerm()	Only perform the operation if the document has this primary term.
final Long	ifSeqNo()	Only perform the operation if the document has this sequence number.
static PutPolicyRequest	of(Function<PutPolicyRequest.Builder,ObjectBuilder<PutPolicyRequest>> fn)
final Policy	policy()	API name: policy
final String	policyId()	Required - API name: policy_id
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	setupPutPolicyRequestDeserializer(ObjectDeserializer<PutPolicyRequest.Builder> op)
PutPolicyRequest.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

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

Json deserializer for PutPolicyRequest

_ENDPOINT

public static final Endpoint<PutPolicyRequest,PutPolicyResponse,ErrorResponse> _ENDPOINT

Endpoint "ism.put_policy".

Method Details

of

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

ifPrimaryTerm

@Nullable
public final Number ifPrimaryTerm()

Only perform the operation if the document has this primary term.

API name: if_primary_term

ifSeqNo

@Nullable
public final Long ifSeqNo()

Only perform the operation if the document has this sequence number.

API name: if_seq_no

policy

@Nullable
public final Policy policy()

API name: policy

policyId

@Nonnull
public final String policyId()

Required - 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 PutPolicyRequest.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<PutPolicyRequest.Builder,PutPolicyRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutPolicyRequest.Builder builder()

setupPutPolicyRequestDeserializer

protected static void setupPutPolicyRequestDeserializer(ObjectDeserializer<PutPolicyRequest.Builder> op)

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object