Package co.elastic.clients.elasticsearch.ccr

Class PauseFollowRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.PauseFollowRequest

public class PauseFollowRequest
extends RequestBase

Pause a follower.

Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<PauseFollowRequest,PauseFollowResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.pause_follow".

Method Summary

Modifier and Type	Method	Description
final String	index()	Required - The name of the follower index.
final Time	masterTimeout()	The period to wait for a connection to the master node.
static PauseFollowRequest	of(Function<PauseFollowRequest.Builder,ObjectBuilder<PauseFollowRequest>> fn)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<PauseFollowRequest,PauseFollowResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.pause_follow".

Method Details

of

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

index

public final String index()

Required - The name of the follower index.

API name: index

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

API name: master_timeout