Package org.opensearch.client.opensearch.ingestion

Class PauseRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingestion.PauseRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

PauseRequest

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

Builder for PauseRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PauseRequest	build()	Builds a PauseRequest.
final PauseRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Time to wait for cluster manager connection.
final PauseRequest.Builder	clusterManagerTimeout(Time value)	Time to wait for cluster manager connection.
PauseRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PauseRequest.Builder	index(String value)	Required - Index for which ingestion should be paused.
protected PauseRequest.Builder	self()
final PauseRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Timeout for the request.
final PauseRequest.Builder	timeout(Time value)	Timeout for the request.

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

Returns:

a new builder instance.

self

@Nonnull
protected PauseRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PauseRequest.Builder>

clusterManagerTimeout

@Nonnull
public final PauseRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Time to wait for cluster manager connection.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PauseRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Time to wait for cluster manager connection.

API name: cluster_manager_timeout

index

@Nonnull
public final PauseRequest.Builder index(String value)

Required - Index for which ingestion should be paused.

API name: index

timeout

@Nonnull
public final PauseRequest.Builder timeout(@Nullable
 Time value)

Timeout for the request.

API name: timeout

timeout

@Nonnull
public final PauseRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Timeout for the request.

API name: timeout

build

@Nonnull
public PauseRequest build()

Builds a PauseRequest.

Specified by:

build in interface ObjectBuilder<PauseRequest>

Throws:

NullPointerException - if some of the required fields are null.