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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutPolicyRequest> Json deserializer forPutPolicyRequeststatic final Endpoint<PutPolicyRequest, PutPolicyResponse, ErrorResponse> Endpoint "ism.put_policy". -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyQueryParameters(Map<String, String> params) static PutPolicyRequest.Builderbuilder()booleaninthashCode()final NumberOnly perform the operation if the document has this primary term.final LongifSeqNo()Only perform the operation if the document has this sequence number.static PutPolicyRequestfinal Policypolicy()API name:policyfinal StringpolicyId()Required - API name:policy_idvoidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.Methods inherited from class org.opensearch.client.opensearch._types.RequestBase
errorTrace, humanMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forPutPolicyRequest -
_ENDPOINT
Endpoint "ism.put_policy".
-
-
Method Details
-
of
public static PutPolicyRequest of(Function<PutPolicyRequest.Builder, ObjectBuilder<PutPolicyRequest>> fn) -
ifPrimaryTerm
Only perform the operation if the document has this primary term.API name:
if_primary_term -
ifSeqNo
Only perform the operation if the document has this sequence number.API name:
if_seq_no -
policy
API name:policy -
policyId
Required - API name:policy_id -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<PutPolicyRequest.Builder,PutPolicyRequest> - Returns:
- a new builder instance.
-
builder
-
setupPutPolicyRequestDeserializer
protected static void setupPutPolicyRequestDeserializer(ObjectDeserializer<PutPolicyRequest.Builder> op) -
applyQueryParameters
- Overrides:
applyQueryParametersin classRequestBase
-
hashCode
public int hashCode() -
equals
-