Package co.elastic.clients.elasticsearch.cluster.remote_info

Class ClusterRemoteProxyInfo

java.lang.Object
co.elastic.clients.elasticsearch.cluster.remote_info.ClusterRemoteProxyInfo
All Implemented Interfaces:
ClusterRemoteInfoVariant, JsonpSerializable
@JsonpDeserializable public class ClusterRemoteProxyInfo extends Object implements ClusterRemoteInfoVariant, JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • _clusterRemoteInfoKind

      public ClusterRemoteInfo.Kind _clusterRemoteInfoKind()
      ClusterRemoteInfo variant kind.
      Specified by:
      _clusterRemoteInfoKind in interface ClusterRemoteInfoVariant

    • connected

      public final boolean connected()
      Required - If it is true, there is at least one open connection to the remote cluster. If it is false, it means that the cluster no longer has an open connection to the remote cluster. It does not necessarily mean that the remote cluster is down or unavailable, just that at some point a connection was lost.

      API name: connected

    • initialConnectTimeout

      public final Time initialConnectTimeout()
      Required - The initial connect timeout for remote cluster connections.

      API name: initial_connect_timeout

    • skipUnavailable

      public final boolean skipUnavailable()
      Required - If true, cross-cluster search skips the remote cluster when its nodes are unavailable during the search and ignores errors returned by the remote cluster.

      API name: skip_unavailable

    • proxyAddress

      public final String proxyAddress()
      Required - The address for remote connections when proxy mode is configured.

      API name: proxy_address

    • serverName

      public final String serverName()
      Required - API name: server_name

    • numProxySocketsConnected

      public final int numProxySocketsConnected()
      Required - The number of open socket connections to the remote cluster when proxy mode is configured.

      API name: num_proxy_sockets_connected

    • maxProxySocketConnections

      public final int maxProxySocketConnections()
      Required - The maximum number of socket connections to the remote cluster when proxy mode is configured.

      API name: max_proxy_socket_connections

    • clusterCredentials

      @Nullable public final String clusterCredentials()
      This field is present and has a value of ::es_redacted:: only when the remote cluster is configured with the API key based model. Otherwise, the field is not present.

      API name: cluster_credentials

    • 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)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupClusterRemoteProxyInfoDeserializer

      protected static void setupClusterRemoteProxyInfoDeserializer(ObjectDeserializer<ClusterRemoteProxyInfo.Builder> op)