Package org.opensearch.client.opensearch.ism

Class PutPolicyRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutPolicyRequest.Builder>

org.opensearch.client.opensearch.ism.PutPolicyRequest.Builder

All Implemented Interfaces:

CopyableBuilder<PutPolicyRequest.Builder,PutPolicyRequest>, MutableBuilder<PutPolicyRequest.Builder,PutPolicyRequest>, ObjectBuilder<PutPolicyRequest>

Enclosing class:

PutPolicyRequest

public static class PutPolicyRequest.Builder
extends RequestBase.AbstractBuilder<PutPolicyRequest.Builder>
implements CopyableBuilder<PutPolicyRequest.Builder,PutPolicyRequest>

Builder for PutPolicyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutPolicyRequest	build()	Builds a PutPolicyRequest.
PutPolicyRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutPolicyRequest.Builder	ifPrimaryTerm(Number value)	Only perform the operation if the document has this primary term.
final PutPolicyRequest.Builder	ifSeqNo(Long value)	Only perform the operation if the document has this sequence number.
final PutPolicyRequest.Builder	policy(Function<Policy.Builder,ObjectBuilder<Policy>> fn)	API name: policy
final PutPolicyRequest.Builder	policy(Policy value)	API name: policy
final PutPolicyRequest.Builder	policyId(String value)	Required - API name: policy_id
protected PutPolicyRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PutPolicyRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PutPolicyRequest.Builder,PutPolicyRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutPolicyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutPolicyRequest.Builder>

ifPrimaryTerm

@Nonnull
public final PutPolicyRequest.Builder ifPrimaryTerm(@Nullable
 Number value)

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

API name: if_primary_term

ifSeqNo

@Nonnull
public final PutPolicyRequest.Builder ifSeqNo(@Nullable
 Long value)

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

API name: if_seq_no

policy

@Nonnull
public final PutPolicyRequest.Builder policy(@Nullable
 Policy value)

API name: policy

policy

@Nonnull
public final PutPolicyRequest.Builder policy(Function<Policy.Builder,ObjectBuilder<Policy>> fn)

API name: policy

policyId

@Nonnull
public final PutPolicyRequest.Builder policyId(String value)

Required - API name: policy_id

build

@Nonnull
public PutPolicyRequest build()

Builds a PutPolicyRequest.

Specified by:

build in interface ObjectBuilder<PutPolicyRequest>

Throws:

NullPointerException - if some of the required fields are null.