Package org.opensearch.client.opensearch.ism

Class IncludeState.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.IncludeState.Builder

All Implemented Interfaces:

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

Enclosing class:

IncludeState

public static class IncludeState.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IncludeState.Builder,IncludeState>

Builder for IncludeState.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IncludeState	build()	Builds a IncludeState.
IncludeState.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IncludeState.Builder	state(String value)	The name of the state to include.

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

Returns:

a new builder instance.

state

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

The name of the state to include.

API name: state

build

@Nonnull
public IncludeState build()

Builds a IncludeState.

Specified by:

build in interface ObjectBuilder<IncludeState>

Throws:

NullPointerException - if some of the required fields are null.