Package org.opensearch.client.opensearch.ism

Class PutPoliciesRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ism.PutPoliciesRequest

All Implemented Interfaces:

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

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

Creates or updates policies.

Nested Class Summary

Nested Classes

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

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<PutPoliciesRequest>	_DESERIALIZER	Json deserializer for PutPoliciesRequest
static final Endpoint<PutPoliciesRequest,PutPoliciesResponse,ErrorResponse>	_ENDPOINT	Endpoint "ism.put_policies".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PutPoliciesRequest.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 PutPoliciesRequest	of(Function<PutPoliciesRequest.Builder,ObjectBuilder<PutPoliciesRequest>> fn)
final Policy	policy()	API name: policy
final String	policyId()	Required - API name: policyID
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	setupPutPoliciesRequestDeserializer(ObjectDeserializer<PutPoliciesRequest.Builder> op)
PutPoliciesRequest.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<PutPoliciesRequest> _DESERIALIZER

Json deserializer for PutPoliciesRequest

_ENDPOINT

public static final Endpoint<PutPoliciesRequest,PutPoliciesResponse,ErrorResponse> _ENDPOINT

Endpoint "ism.put_policies".

Method Details

of

public static PutPoliciesRequest of(Function<PutPoliciesRequest.Builder,ObjectBuilder<PutPoliciesRequest>> 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: policyID

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

Returns:

a new builder instance.

builder

@Nonnull
public static PutPoliciesRequest.Builder builder()

setupPutPoliciesRequestDeserializer

protected static void setupPutPoliciesRequestDeserializer(ObjectDeserializer<PutPoliciesRequest.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