Package org.opensearch.client.opensearch.nodes.stats

Class Transport.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.nodes.stats.Transport.Builder
All Implemented Interfaces:
CopyableBuilder<Transport.Builder,Transport>, MutableBuilder<Transport.Builder,Transport>, ObjectBuilder<Transport>
Enclosing class:
Transport
public static class Transport.Builder extends ObjectBuilderBase implements CopyableBuilder<Transport.Builder,Transport>
Builder for Transport.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public Transport.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<Transport.Builder,Transport>
      Returns:
      a new builder instance.

    • rxCount

      @Nonnull public final Transport.Builder rxCount(@Nullable Long value)
      Total number of RX (receive) packets received by the node during internal cluster communication.

      API name: rx_count

    • rxSize

      @Nonnull public final Transport.Builder rxSize(@Nullable String value)
      Size of RX packets received by the node during internal cluster communication.

      API name: rx_size

    • rxSizeInBytes

      @Nonnull public final Transport.Builder rxSizeInBytes(@Nullable Long value)
      Size, in bytes, of RX packets received by the node during internal cluster communication.

      API name: rx_size_in_bytes

    • serverOpen

      @Nonnull public final Transport.Builder serverOpen(@Nullable Long value)
      Current number of inbound TCP connections used for internal communication between nodes.

      API name: server_open

    • totalOutboundConnections

      @Nonnull public final Transport.Builder totalOutboundConnections(@Nullable Long value)
      The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.

      API name: total_outbound_connections

    • txCount

      @Nonnull public final Transport.Builder txCount(@Nullable Long value)
      Total number of TX (transmit) packets sent by the node during internal cluster communication.

      API name: tx_count

    • txSize

      @Nonnull public final Transport.Builder txSize(@Nullable String value)
      Size of TX packets sent by the node during internal cluster communication.

      API name: tx_size

    • txSizeInBytes

      @Nonnull public final Transport.Builder txSizeInBytes(@Nullable Long value)
      Size, in bytes, of TX packets sent by the node during internal cluster communication.

      API name: tx_size_in_bytes

    • build

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