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

Class Breaker.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public Breaker.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<Breaker.Builder,Breaker>
      Returns:
      a new builder instance.

    • estimatedSize

      @Nonnull public final Breaker.Builder estimatedSize(@Nullable String value)
      Estimated memory used for the operation.

      API name: estimated_size

    • estimatedSizeInBytes

      @Nonnull public final Breaker.Builder estimatedSizeInBytes(@Nullable Long value)
      Estimated memory used, in bytes, for the operation.

      API name: estimated_size_in_bytes

    • limitSize

      @Nonnull public final Breaker.Builder limitSize(@Nullable String value)
      Memory limit for the circuit breaker.

      API name: limit_size

    • limitSizeInBytes

      @Nonnull public final Breaker.Builder limitSizeInBytes(@Nullable Long value)
      Memory limit, in bytes, for the circuit breaker.

      API name: limit_size_in_bytes

    • overhead

      @Nonnull public final Breaker.Builder overhead(@Nullable Double value)
      A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.

      API name: overhead

    • tripped

      @Nonnull public final Breaker.Builder tripped(@Nullable Long value)
      Total number of times the circuit breaker has been triggered and prevented an out of memory error.

      API name: tripped

    • build

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