Package org.opensearch.client.opensearch.ingestion

Class PauseRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.ingestion.PauseRequest

All Implemented Interfaces:

ToCopyableBuilder<PauseRequest.Builder,PauseRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PauseRequest
extends RequestBase
implements ToCopyableBuilder<PauseRequest.Builder,PauseRequest>

Use this API to pause ingestion for a given index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PauseRequest.Builder	Builder for PauseRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<PauseRequest,PauseResponse,ErrorResponse>	_ENDPOINT	Endpoint "ingestion.pause".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static PauseRequest.Builder	builder()
final Time	clusterManagerTimeout()	Time to wait for cluster manager connection.
boolean	equals(Object o)
int	hashCode()
final String	index()	Required - Index for which ingestion should be paused.
static PauseRequest	of(Function<PauseRequest.Builder,ObjectBuilder<PauseRequest>> fn)
final Time	timeout()	Timeout for the request.
PauseRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

errorTrace, human

Methods inherited from class java.lang.Object

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

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

copy

Field Details

_ENDPOINT

public static final Endpoint<PauseRequest,PauseResponse,ErrorResponse> _ENDPOINT

Endpoint "ingestion.pause".

Method Details

of

public static PauseRequest of(Function<PauseRequest.Builder,ObjectBuilder<PauseRequest>> fn)

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Time to wait for cluster manager connection.

API name: cluster_manager_timeout

index

@Nonnull
public final String index()

Required - Index for which ingestion should be paused.

API name: index

timeout

@Nullable
public final Time timeout()

Timeout for the request.

API name: timeout

toBuilder

@Nonnull
public PauseRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PauseRequest.Builder,PauseRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PauseRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object