Package co.elastic.clients.elasticsearch.cluster

Class RemoteInfoRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.RemoteInfoRequest

public class RemoteInfoRequest
extends RequestBase

Get remote cluster information.

Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.

info This API returns information that reflects current state on the local cluster. The connected field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the resolve cluster endpoint.

See Also:

• API specification

Nested Class Summary

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<RemoteInfoRequest,RemoteInfoResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.remote_info".
static final RemoteInfoRequest	_INSTANCE	Singleton instance for RemoteInfoRequest.

Constructor Summary

Constructors

Constructor	Description
RemoteInfoRequest()

Method Summary

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

_INSTANCE

public static final RemoteInfoRequest _INSTANCE

Singleton instance for RemoteInfoRequest.

_ENDPOINT

public static final Endpoint<RemoteInfoRequest,RemoteInfoResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.remote_info".

Constructor Details

RemoteInfoRequest

public RemoteInfoRequest()