CircuitBreakerStatus (Lagom Services API)

Object
- com.lightbend.lagom.javadsl.server.status.CircuitBreakerStatus

All Implemented Interfaces:: AbstractCircuitBreakerStatus

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","AbstractCircuitBreakerStatus"})
 @Immutable
public final class CircuitBreakerStatus
extends Object
implements AbstractCircuitBreakerStatus

Immutable implementation of AbstractCircuitBreakerStatus.

Use the builder to create immutable instances: CircuitBreakerStatus.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CircuitBreakerStatus.Builder
Builds instances of type CircuitBreakerStatus.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CircuitBreakerStatus.Builder` Builds instances of type `CircuitBreakerStatus`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CircuitBreakerStatus.Builder`	`builder()` Creates a builder for `CircuitBreakerStatus`.
`static CircuitBreakerStatus`	`copyOf(AbstractCircuitBreakerStatus instance)` Creates an immutable copy of a `AbstractCircuitBreakerStatus` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `CircuitBreakerStatus` that have equal attribute values.
`double`	`getFailedThroughputOneMinute()` Failed calls per second for the last minute.
`String`	`getId()` Circuit breaker identifier.
`Latency`	`getLatencyMicros()` Latency distribution for Exponentially Decaying Reservoir.
`String`	`getState()` Circuit breaker state; closed, open, half-open.
`double`	`getThroughputOneMinute()` Total (successful + failed) calls per second for the last minute.
`java.time.Instant`	`getTimestamp()`
`long`	`getTotalFailureCount()` Total number of failed calls.
`long`	`getTotalSuccessCount()` Total number of successful calls.
`int`	`hashCode()` Computes a hash code from attributes: `id`, `timestamp`, `state`, `totalSuccessCount`, `totalFailureCount`, `latencyMicros`, `throughputOneMinute`, `failedThroughputOneMinute`.
`String`	`toString()` Prints the immutable value `CircuitBreakerStatus...` with all non-generated and non-auxiliary attribute values.
`CircuitBreakerStatus`	`withFailedThroughputOneMinute(double value)` Copy the current immutable object by setting a value for the `failedThroughputOneMinute` attribute.
`CircuitBreakerStatus`	`withId(String value)` Copy the current immutable object by setting a value for the `id` attribute.
`CircuitBreakerStatus`	`withLatencyMicros(Latency value)` Copy the current immutable object by setting a value for the `latencyMicros` attribute.
`CircuitBreakerStatus`	`withState(String value)` Copy the current immutable object by setting a value for the `state` attribute.
`CircuitBreakerStatus`	`withThroughputOneMinute(double value)` Copy the current immutable object by setting a value for the `throughputOneMinute` attribute.
`CircuitBreakerStatus`	`withTimestamp(java.time.Instant value)` Copy the current immutable object by setting a value for the `timestamp` attribute.
`CircuitBreakerStatus`	`withTotalFailureCount(long value)` Copy the current immutable object by setting a value for the `totalFailureCount` attribute.
`CircuitBreakerStatus`	`withTotalSuccessCount(long value)` Copy the current immutable object by setting a value for the `totalSuccessCount` attribute.

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getId
```
public String getId()
```
    Circuit breaker identifier.
    
    Specified by:
    
    getId in interface AbstractCircuitBreakerStatus
  - getTimestamp
```
public java.time.Instant getTimestamp()
```
    Specified by:
    
    getTimestamp in interface AbstractCircuitBreakerStatus
    
    Returns:
    
    The value of the timestamp attribute
  - getState
```
public String getState()
```
    Circuit breaker state; closed, open, half-open.
    
    Specified by:
    
    getState in interface AbstractCircuitBreakerStatus
  - getTotalSuccessCount
```
public long getTotalSuccessCount()
```
    Total number of successful calls.
    
    Specified by:
    
    getTotalSuccessCount in interface AbstractCircuitBreakerStatus
  - getTotalFailureCount
```
public long getTotalFailureCount()
```
    Total number of failed calls.
    
    Specified by:
    
    getTotalFailureCount in interface AbstractCircuitBreakerStatus
  - getLatencyMicros
```
public Latency getLatencyMicros()
```
    Latency distribution for Exponentially Decaying Reservoir. Time unit is microseconds.
    
    Specified by:
    
    getLatencyMicros in interface AbstractCircuitBreakerStatus
  - getThroughputOneMinute
```
public double getThroughputOneMinute()
```
    Total (successful + failed) calls per second for the last minute.
    
    Specified by:
    
    getThroughputOneMinute in interface AbstractCircuitBreakerStatus
  - getFailedThroughputOneMinute
```
public double getFailedThroughputOneMinute()
```
    Failed calls per second for the last minute.
    
    Specified by:
    
    getFailedThroughputOneMinute in interface AbstractCircuitBreakerStatus
  - withId
```
public final CircuitBreakerStatus withId(String value)
```
    Copy the current immutable object by setting a value for the id attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for id
    
    Returns:
    
    A modified copy of the this object
  - withTimestamp
```
public final CircuitBreakerStatus withTimestamp(java.time.Instant value)
```
    Copy the current immutable object by setting a value for the timestamp attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for timestamp
    
    Returns:
    
    A modified copy of the this object
  - withState
```
public final CircuitBreakerStatus withState(String value)
```
    Copy the current immutable object by setting a value for the state attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for state
    
    Returns:
    
    A modified copy of the this object
  - withTotalSuccessCount
```
public final CircuitBreakerStatus withTotalSuccessCount(long value)
```
    Copy the current immutable object by setting a value for the totalSuccessCount attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalSuccessCount
    
    Returns:
    
    A modified copy of the this object
  - withTotalFailureCount
```
public final CircuitBreakerStatus withTotalFailureCount(long value)
```
    Copy the current immutable object by setting a value for the totalFailureCount attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalFailureCount
    
    Returns:
    
    A modified copy of the this object
  - withLatencyMicros
```
public final CircuitBreakerStatus withLatencyMicros(Latency value)
```
    Copy the current immutable object by setting a value for the latencyMicros attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for latencyMicros
    
    Returns:
    
    A modified copy of the this object
  - withThroughputOneMinute
```
public final CircuitBreakerStatus withThroughputOneMinute(double value)
```
    Copy the current immutable object by setting a value for the throughputOneMinute attribute.
    
    Parameters:
    
    value - A new value for throughputOneMinute
    
    Returns:
    
    A modified copy of the this object
  - withFailedThroughputOneMinute
```
public final CircuitBreakerStatus withFailedThroughputOneMinute(double value)
```
    Copy the current immutable object by setting a value for the failedThroughputOneMinute attribute.
    
    Parameters:
    
    value - A new value for failedThroughputOneMinute
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of CircuitBreakerStatus that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: id, timestamp, state, totalSuccessCount, totalFailureCount, latencyMicros, throughputOneMinute, failedThroughputOneMinute.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CircuitBreakerStatus... with all non-generated and non-auxiliary attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static CircuitBreakerStatus copyOf(AbstractCircuitBreakerStatus instance)
```
    Creates an immutable copy of a AbstractCircuitBreakerStatus value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable CircuitBreakerStatus instance
  - builder
```
public static CircuitBreakerStatus.Builder builder()
```
    Creates a builder for CircuitBreakerStatus.
    
    Returns:
    
    A new CircuitBreakerStatus builder

Class CircuitBreakerStatus

Nested Class Summary

Method Summary

Methods inherited from class Object

Method Detail

getId

getTimestamp

getState

getTotalSuccessCount

getTotalFailureCount

getLatencyMicros

getThroughputOneMinute

getFailedThroughputOneMinute

withId

withTimestamp

withState

withTotalSuccessCount

withTotalFailureCount

withLatencyMicros

withThroughputOneMinute

withFailedThroughputOneMinute

equals

hashCode

toString

copyOf

builder