Package org.opensearch.client.opensearch.ism

Class PutPoliciesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ism.PutPoliciesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PutPoliciesRequest

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

Builder for PutPoliciesRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected PutPoliciesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutPoliciesRequest.Builder>

ifPrimaryTerm

@Nonnull
public final PutPoliciesRequest.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 PutPoliciesRequest.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 PutPoliciesRequest.Builder policy(@Nullable
 Policy value)

API name: policy

policy

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

API name: policy

policyId

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

Required - API name: policyID

build

@Nonnull
public PutPoliciesRequest build()

Builds a PutPoliciesRequest.

Specified by:

build in interface ObjectBuilder<PutPoliciesRequest>

Throws:

NullPointerException - if some of the required fields are null.