Package org.opensearch.client.opensearch.ism

Class ChangePolicyRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ism.ChangePolicyRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ChangePolicyRequest

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

Builder for ChangePolicyRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChangePolicyRequest	build()	Builds a ChangePolicyRequest.
ChangePolicyRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ChangePolicyRequest.Builder	include(Function<IncludeState.Builder,ObjectBuilder<IncludeState>> fn)	The states to include in the policy change.
final ChangePolicyRequest.Builder	include(List<IncludeState> list)	The states to include in the policy change.
final ChangePolicyRequest.Builder	include(IncludeState value, IncludeState... values)	The states to include in the policy change.
final ChangePolicyRequest.Builder	index(String value)	API name: index
final ChangePolicyRequest.Builder	policyId(String value)	Required - The ID of the new policy.
protected ChangePolicyRequest.Builder	self()
final ChangePolicyRequest.Builder	state(String value)	The state to transition to.

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

Returns:

a new builder instance.

self

@Nonnull
protected ChangePolicyRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ChangePolicyRequest.Builder>

include

@Nonnull
public final ChangePolicyRequest.Builder include(List<IncludeState> list)

The states to include in the policy change.

API name: include

Adds all elements of list to include.

include

@Nonnull
public final ChangePolicyRequest.Builder include(IncludeState value,
 IncludeState... values)

The states to include in the policy change.

API name: include

Adds one or more values to include.

include

@Nonnull
public final ChangePolicyRequest.Builder include(Function<IncludeState.Builder,ObjectBuilder<IncludeState>> fn)

The states to include in the policy change.

API name: include

Adds a value to include using a builder lambda.

index

@Nonnull
public final ChangePolicyRequest.Builder index(@Nullable
 String value)

API name: index

policyId

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

Required - The ID of the new policy.

API name: policy_id

state

@Nonnull
public final ChangePolicyRequest.Builder state(@Nullable
 String value)

The state to transition to.

API name: state

build

@Nonnull
public ChangePolicyRequest build()

Builds a ChangePolicyRequest.

Specified by:

build in interface ObjectBuilder<ChangePolicyRequest>

Throws:

NullPointerException - if some of the required fields are null.