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

Class ClusterRemoteProxyInfo.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<ClusterRemoteProxyInfo.Builder>
co.elastic.clients.elasticsearch.cluster.remote_info.ClusterRemoteProxyInfo.Builder
All Implemented Interfaces:
WithJson<ClusterRemoteProxyInfo.Builder>, ObjectBuilder<ClusterRemoteProxyInfo>
Enclosing class:
ClusterRemoteProxyInfo
public static class ClusterRemoteProxyInfo.Builder extends WithJsonObjectBuilderBase<ClusterRemoteProxyInfo.Builder> implements ObjectBuilder<ClusterRemoteProxyInfo>
Builder for ClusterRemoteProxyInfo.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • connected

      public final ClusterRemoteProxyInfo.Builder connected(boolean value)
      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 ClusterRemoteProxyInfo.Builder initialConnectTimeout(Time value)
      Required - The initial connect timeout for remote cluster connections.

      API name: initial_connect_timeout

    • initialConnectTimeout

      public final ClusterRemoteProxyInfo.Builder initialConnectTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Required - The initial connect timeout for remote cluster connections.

      API name: initial_connect_timeout

    • skipUnavailable

      public final ClusterRemoteProxyInfo.Builder skipUnavailable(boolean value)
      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 ClusterRemoteProxyInfo.Builder proxyAddress(String value)
      Required - The address for remote connections when proxy mode is configured.

      API name: proxy_address

    • serverName

      public final ClusterRemoteProxyInfo.Builder serverName(String value)
      Required - API name: server_name

    • numProxySocketsConnected

      public final ClusterRemoteProxyInfo.Builder numProxySocketsConnected(int value)
      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 ClusterRemoteProxyInfo.Builder maxProxySocketConnections(int value)
      Required - The maximum number of socket connections to the remote cluster when proxy mode is configured.

      API name: max_proxy_socket_connections

    • clusterCredentials

      public final ClusterRemoteProxyInfo.Builder clusterCredentials(@Nullable String value)
      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

    • self

      protected ClusterRemoteProxyInfo.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<ClusterRemoteProxyInfo.Builder>

    • build

      public ClusterRemoteProxyInfo build()
      Builds a ClusterRemoteProxyInfo.
      Specified by:
      build in interface ObjectBuilder<ClusterRemoteProxyInfo>
      Throws:
      NullPointerException - if some of the required fields are null.