Package co.elastic.clients.elasticsearch.ccr

Class FollowStatsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.FollowStatsRequest

public class FollowStatsRequest
extends RequestBase

Get follower stats.

Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<FollowStatsRequest,FollowStatsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.follow_stats".

Method Summary

Modifier and Type	Method	Description
final List<String>	index()	Required - A comma-delimited list of index patterns.
static FollowStatsRequest	of(Function<FollowStatsRequest.Builder,ObjectBuilder<FollowStatsRequest>> fn)
final Time	timeout()	The period to wait for a response.

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<FollowStatsRequest,FollowStatsResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.follow_stats".

Method Details

of

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

index

public final List<String> index()

Required - A comma-delimited list of index patterns.

API name: index

timeout

@Nullable
public final Time timeout()

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout