Package co.elastic.clients.elasticsearch.ccr

Class ForgetFollowerRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ccr.ForgetFollowerRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ForgetFollowerRequest
extends RequestBase
implements JsonpSerializable

Forget a follower. Remove the cross-cluster replication follower retention leases from the leader.

A following index takes out retention leases on its leader index. These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. This API exists to enable manually removing the leases when the unfollow API is unable to do so.

NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<ForgetFollowerRequest>	_DESERIALIZER	Json deserializer for ForgetFollowerRequest
static final Endpoint<ForgetFollowerRequest,ForgetFollowerResponse,ErrorResponse>	_ENDPOINT	Endpoint "ccr.forget_follower".

Method Summary

Modifier and Type	Method	Description
final String	followerCluster()	API name: follower_cluster
final String	followerIndex()	API name: follower_index
final String	followerIndexUuid()	API name: follower_index_uuid
final String	index()	Required - the name of the leader index for which specified follower retention leases should be removed
final String	leaderRemoteCluster()	API name: leader_remote_cluster
static ForgetFollowerRequest	of(Function<ForgetFollowerRequest.Builder,ObjectBuilder<ForgetFollowerRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupForgetFollowerRequestDeserializer(ObjectDeserializer<ForgetFollowerRequest.Builder> op)
final Time	timeout()	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

_DESERIALIZER

public static final JsonpDeserializer<ForgetFollowerRequest> _DESERIALIZER

Json deserializer for ForgetFollowerRequest

_ENDPOINT

public static final Endpoint<ForgetFollowerRequest,ForgetFollowerResponse,ErrorResponse> _ENDPOINT

Endpoint "ccr.forget_follower".

Method Details

of

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

followerCluster

@Nullable
public final String followerCluster()

API name: follower_cluster

followerIndex

@Nullable
public final String followerIndex()

API name: follower_index

followerIndexUuid

@Nullable
public final String followerIndexUuid()

API name: follower_index_uuid

index

public final String index()

Required - the name of the leader index for which specified follower retention leases should be removed

API name: index

leaderRemoteCluster

@Nullable
public final String leaderRemoteCluster()

API name: leader_remote_cluster

timeout

@Nullable
public final Time timeout()

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

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupForgetFollowerRequestDeserializer

protected static void setupForgetFollowerRequestDeserializer(ObjectDeserializer<ForgetFollowerRequest.Builder> op)