Package co.elastic.clients.elasticsearch.ccr

Class PauseAutoFollowPatternRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.PauseAutoFollowPatternRequest

public class PauseAutoFollowPatternRequest
extends RequestBase

Pause an auto-follow pattern.

Pause a cross-cluster replication auto-follow pattern. When the API returns, the auto-follow pattern is inactive. New indices that are created on the remote cluster and match the auto-follow patterns are ignored.

You can resume auto-following with the resume auto-follow pattern API. When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PauseAutoFollowPatternRequest,PauseAutoFollowPatternResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.pause_auto_follow_pattern".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for a connection to the master node.
final String	name()	Required - The name of the auto-follow pattern to pause.
static PauseAutoFollowPatternRequest	of(Function<PauseAutoFollowPatternRequest.Builder,ObjectBuilder<PauseAutoFollowPatternRequest>> 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<PauseAutoFollowPatternRequest,PauseAutoFollowPatternResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.pause_auto_follow_pattern".

Method Details

of

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

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

name

public final String name()

Required - The name of the auto-follow pattern to pause.

API name: name