Package co.elastic.clients.elasticsearch.ccr

Class UnfollowRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.UnfollowRequest

public class UnfollowRequest
extends RequestBase

Unfollow an index.

Convert a cross-cluster replication follower index to a regular index. The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. The follower index must be paused and closed before you call the unfollow API.

info Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UnfollowRequest,UnfollowResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.unfollow".

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 UnfollowRequest	of(Function<UnfollowRequest.Builder,ObjectBuilder<UnfollowRequest>> 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<UnfollowRequest,UnfollowResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.unfollow".

Method Details

of

public static UnfollowRequest of(Function<UnfollowRequest.Builder,ObjectBuilder<UnfollowRequest>> 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