Package co.elastic.clients.elasticsearch.ccr

Class FollowInfoRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.FollowInfoRequest

public class FollowInfoRequest
extends RequestBase

Get follower information.

Get information about all cross-cluster replication follower indices. For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<FollowInfoRequest,FollowInfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.follow_info".

Method Summary

Modifier and Type	Method	Description
final List<String>	index()	Required - A comma-delimited list of follower index patterns.
final Time	masterTimeout()	The period to wait for a connection to the master node.
static FollowInfoRequest	of(Function<FollowInfoRequest.Builder,ObjectBuilder<FollowInfoRequest>> 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<FollowInfoRequest,FollowInfoResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.follow_info".

Method Details

of

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

index

public final List<String> index()

Required - A comma-delimited list of follower index patterns.

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