ImmutableSummaryStats (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.common.model.ImmutableSummaryStats

All Implemented Interfaces:: SummaryStats

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableSummaryStats
extends Object
implements SummaryStats

Immutable implementation of SummaryStats.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSummaryStats.Builder
Builds instances of type ImmutableSummaryStats.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<Duration>`	`averageRunTime()` Specifies the average run time of all successful backup runs.
`static ImmutableSummaryStats.Builder`	`builder()` Creates a builder for `ImmutableSummaryStats`.
`static ImmutableSummaryStats`	`copyOf(SummaryStats instance)` Creates an immutable copy of a `SummaryStats` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSummaryStats` that have equal attribute values.
`Optional<Duration>`	`fastestRunTime()` Specifies the time taken for a fastest successful backup run so far.
`int`	`hashCode()` Computes a hash code from attributes: `numRunningRuns`, `numCanceledRuns`, `numFailedRuns`, `numSlaViolations`, `numSuccessfulRuns`, `averageRunTime`, `fastestRunTime`, `slowestRunTime`, `totalRunTime`, `totalBytesReadFromSource`, `totalLogicalBackupSizeBytes`, `totalPhysicalBackupSizeBytes`.
`long`	`numCanceledRuns()` Specifies the number of runs that were canceled.
`long`	`numFailedRuns()` Specifies the number of runs that failed to finish.
`long`	`numRunningRuns()` Specifies the number of runs that are still running.
`long`	`numSlaViolations()` Specifies the number of runs having SLA violations.
`long`	`numSuccessfulRuns()` Specifies the number of runs that finished successfully.
`Optional<Duration>`	`slowestRunTime()` Specifies the time taken for a slowest successful backup run so far.
`String`	`toString()` Prints the immutable value `SummaryStats` with attribute values.
`long`	`totalBytesReadFromSource()` Specifies the total amount of data read from the source (so far).
`long`	`totalLogicalBackupSizeBytes()` Specifies the size of the source object (such as a VM) protected by this task on the primary storage after the snapshot is taken.
`long`	`totalPhysicalBackupSizeBytes()` Specifies the total amount of physical space used to store the protected object after being reduced by change-block tracking, compression and deduplication.
`Duration`	`totalRunTime()` The total run time taken by all successful backup runs.
`ImmutableSummaryStats`	`withAverageRunTime(Duration value)` Copy the current immutable object by setting a present value for the optional `averageRunTime` attribute.
`ImmutableSummaryStats`	`withAverageRunTime(Optional<? extends Duration> optional)` Copy the current immutable object by setting an optional value for the `averageRunTime` attribute.
`ImmutableSummaryStats`	`withFastestRunTime(Duration value)` Copy the current immutable object by setting a present value for the optional `fastestRunTime` attribute.
`ImmutableSummaryStats`	`withFastestRunTime(Optional<? extends Duration> optional)` Copy the current immutable object by setting an optional value for the `fastestRunTime` attribute.
`ImmutableSummaryStats`	`withNumCanceledRuns(long value)` Copy the current immutable object by setting a value for the `numCanceledRuns` attribute.
`ImmutableSummaryStats`	`withNumFailedRuns(long value)` Copy the current immutable object by setting a value for the `numFailedRuns` attribute.
`ImmutableSummaryStats`	`withNumRunningRuns(long value)` Copy the current immutable object by setting a value for the `numRunningRuns` attribute.
`ImmutableSummaryStats`	`withNumSlaViolations(long value)` Copy the current immutable object by setting a value for the `numSlaViolations` attribute.
`ImmutableSummaryStats`	`withNumSuccessfulRuns(long value)` Copy the current immutable object by setting a value for the `numSuccessfulRuns` attribute.
`ImmutableSummaryStats`	`withSlowestRunTime(Duration value)` Copy the current immutable object by setting a present value for the optional `slowestRunTime` attribute.
`ImmutableSummaryStats`	`withSlowestRunTime(Optional<? extends Duration> optional)` Copy the current immutable object by setting an optional value for the `slowestRunTime` attribute.
`ImmutableSummaryStats`	`withTotalBytesReadFromSource(long value)` Copy the current immutable object by setting a value for the `totalBytesReadFromSource` attribute.
`ImmutableSummaryStats`	`withTotalLogicalBackupSizeBytes(long value)` Copy the current immutable object by setting a value for the `totalLogicalBackupSizeBytes` attribute.
`ImmutableSummaryStats`	`withTotalPhysicalBackupSizeBytes(long value)` Copy the current immutable object by setting a value for the `totalPhysicalBackupSizeBytes` attribute.
`ImmutableSummaryStats`	`withTotalRunTime(Duration value)` Copy the current immutable object by setting a value for the `totalRunTime` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - numRunningRuns
```
public long numRunningRuns()
```
    Specifies the number of runs that are still running.
    
    Specified by:
    
    numRunningRuns in interface SummaryStats
    
    Returns:
    
    long value
  - numCanceledRuns
```
public long numCanceledRuns()
```
    Specifies the number of runs that were canceled.
    
    Specified by:
    
    numCanceledRuns in interface SummaryStats
    
    Returns:
    
    long value
  - numFailedRuns
```
public long numFailedRuns()
```
    Specifies the number of runs that failed to finish.
    
    Specified by:
    
    numFailedRuns in interface SummaryStats
    
    Returns:
    
    long value
  - numSlaViolations
```
public long numSlaViolations()
```
    Specifies the number of runs having SLA violations.
    
    Specified by:
    
    numSlaViolations in interface SummaryStats
    
    Returns:
    
    long value
  - numSuccessfulRuns
```
public long numSuccessfulRuns()
```
    Specifies the number of runs that finished successfully.
    
    Specified by:
    
    numSuccessfulRuns in interface SummaryStats
    
    Returns:
    
    long value
  - averageRunTime
```
public Optional<Duration> averageRunTime()
```
    Specifies the average run time of all successful backup runs.
    
    Specified by:
    
    averageRunTime in interface SummaryStats
    
    Returns:
    
    Optional of Duration
  - fastestRunTime
```
public Optional<Duration> fastestRunTime()
```
    Specifies the time taken for a fastest successful backup run so far.
    
    Specified by:
    
    fastestRunTime in interface SummaryStats
    
    Returns:
    
    Optional of Duration
  - slowestRunTime
```
public Optional<Duration> slowestRunTime()
```
    Specifies the time taken for a slowest successful backup run so far.
    
    Specified by:
    
    slowestRunTime in interface SummaryStats
    
    Returns:
    
    Optional of Duration
  - totalRunTime
```
public Duration totalRunTime()
```
    The total run time taken by all successful backup runs.
    
    Specified by:
    
    totalRunTime in interface SummaryStats
    
    Returns:
    
    Duration
  - totalBytesReadFromSource
```
public long totalBytesReadFromSource()
```
    Specifies the total amount of data read from the source (so far).
    
    Specified by:
    
    totalBytesReadFromSource in interface SummaryStats
    
    Returns:
    
    long value
  - totalLogicalBackupSizeBytes
```
public long totalLogicalBackupSizeBytes()
```
    Specifies the size of the source object (such as a VM) protected by this task on the primary storage after the snapshot is taken. The logical size of the data on the source if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.
    
    Specified by:
    
    totalLogicalBackupSizeBytes in interface SummaryStats
    
    Returns:
    
    long value
  - totalPhysicalBackupSizeBytes
```
public long totalPhysicalBackupSizeBytes()
```
    Specifies the total amount of physical space used to store the protected object after being reduced by change-block tracking, compression and deduplication. For example, if the logical backup size is 1GB, but only 1MB was used to store it, this field be equal to 1MB.
    
    Specified by:
    
    totalPhysicalBackupSizeBytes in interface SummaryStats
    
    Returns:
    
    long value
  - withNumRunningRuns
```
public final ImmutableSummaryStats withNumRunningRuns(long value)
```
    Copy the current immutable object by setting a value for the numRunningRuns attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numRunningRuns
    
    Returns:
    
    A modified copy of the this object
  - withNumCanceledRuns
```
public final ImmutableSummaryStats withNumCanceledRuns(long value)
```
    Copy the current immutable object by setting a value for the numCanceledRuns attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numCanceledRuns
    
    Returns:
    
    A modified copy of the this object
  - withNumFailedRuns
```
public final ImmutableSummaryStats withNumFailedRuns(long value)
```
    Copy the current immutable object by setting a value for the numFailedRuns attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numFailedRuns
    
    Returns:
    
    A modified copy of the this object
  - withNumSlaViolations
```
public final ImmutableSummaryStats withNumSlaViolations(long value)
```
    Copy the current immutable object by setting a value for the numSlaViolations attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numSlaViolations
    
    Returns:
    
    A modified copy of the this object
  - withNumSuccessfulRuns
```
public final ImmutableSummaryStats withNumSuccessfulRuns(long value)
```
    Copy the current immutable object by setting a value for the numSuccessfulRuns attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numSuccessfulRuns
    
    Returns:
    
    A modified copy of the this object
  - withAverageRunTime
```
public final ImmutableSummaryStats withAverageRunTime(Duration value)
```
    Copy the current immutable object by setting a present value for the optional averageRunTime attribute.
    
    Parameters:
    
    value - The value for averageRunTime
    
    Returns:
    
    A modified copy of this object
  - withAverageRunTime
```
public final ImmutableSummaryStats withAverageRunTime(Optional<? extends Duration> optional)
```
    Copy the current immutable object by setting an optional value for the averageRunTime attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for averageRunTime
    
    Returns:
    
    A modified copy of this object
  - withFastestRunTime
```
public final ImmutableSummaryStats withFastestRunTime(Duration value)
```
    Copy the current immutable object by setting a present value for the optional fastestRunTime attribute.
    
    Parameters:
    
    value - The value for fastestRunTime
    
    Returns:
    
    A modified copy of this object
  - withFastestRunTime
```
public final ImmutableSummaryStats withFastestRunTime(Optional<? extends Duration> optional)
```
    Copy the current immutable object by setting an optional value for the fastestRunTime attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for fastestRunTime
    
    Returns:
    
    A modified copy of this object
  - withSlowestRunTime
```
public final ImmutableSummaryStats withSlowestRunTime(Duration value)
```
    Copy the current immutable object by setting a present value for the optional slowestRunTime attribute.
    
    Parameters:
    
    value - The value for slowestRunTime
    
    Returns:
    
    A modified copy of this object
  - withSlowestRunTime
```
public final ImmutableSummaryStats withSlowestRunTime(Optional<? extends Duration> optional)
```
    Copy the current immutable object by setting an optional value for the slowestRunTime attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for slowestRunTime
    
    Returns:
    
    A modified copy of this object
  - withTotalRunTime
```
public final ImmutableSummaryStats withTotalRunTime(Duration value)
```
    Copy the current immutable object by setting a value for the totalRunTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalRunTime
    
    Returns:
    
    A modified copy of the this object
  - withTotalBytesReadFromSource
```
public final ImmutableSummaryStats withTotalBytesReadFromSource(long value)
```
    Copy the current immutable object by setting a value for the totalBytesReadFromSource attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalBytesReadFromSource
    
    Returns:
    
    A modified copy of the this object
  - withTotalLogicalBackupSizeBytes
```
public final ImmutableSummaryStats withTotalLogicalBackupSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the totalLogicalBackupSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalLogicalBackupSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - withTotalPhysicalBackupSizeBytes
```
public final ImmutableSummaryStats withTotalPhysicalBackupSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the totalPhysicalBackupSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalPhysicalBackupSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableSummaryStats 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: numRunningRuns, numCanceledRuns, numFailedRuns, numSlaViolations, numSuccessfulRuns, averageRunTime, fastestRunTime, slowestRunTime, totalRunTime, totalBytesReadFromSource, totalLogicalBackupSizeBytes, totalPhysicalBackupSizeBytes.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SummaryStats with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSummaryStats copyOf(SummaryStats instance)
```
    Creates an immutable copy of a SummaryStats 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 SummaryStats instance
  - builder
```
public static ImmutableSummaryStats.Builder builder()
```
    Creates a builder for ImmutableSummaryStats.
```
 ImmutableSummaryStats.builder()
    .numRunningRuns(long) // required numRunningRuns
    .numCanceledRuns(long) // required numCanceledRuns
    .numFailedRuns(long) // required numFailedRuns
    .numSlaViolations(long) // required numSlaViolations
    .numSuccessfulRuns(long) // required numSuccessfulRuns
    .averageRunTime(java.time.Duration) // optional averageRunTime
    .fastestRunTime(java.time.Duration) // optional fastestRunTime
    .slowestRunTime(java.time.Duration) // optional slowestRunTime
    .totalRunTime(java.time.Duration) // required totalRunTime
    .totalBytesReadFromSource(long) // required totalBytesReadFromSource
    .totalLogicalBackupSizeBytes(long) // required totalLogicalBackupSizeBytes
    .totalPhysicalBackupSizeBytes(long) // required totalPhysicalBackupSizeBytes
    .build();
 
```
    Returns:
    
    A new ImmutableSummaryStats builder

Class ImmutableSummaryStats

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

numRunningRuns

numCanceledRuns

numFailedRuns

numSlaViolations

numSuccessfulRuns

averageRunTime

fastestRunTime

slowestRunTime

totalRunTime

totalBytesReadFromSource

totalLogicalBackupSizeBytes

totalPhysicalBackupSizeBytes

withNumRunningRuns

withNumCanceledRuns

withNumFailedRuns

withNumSlaViolations

withNumSuccessfulRuns

withAverageRunTime

withAverageRunTime

withFastestRunTime

withFastestRunTime

withSlowestRunTime

withSlowestRunTime

withTotalRunTime

withTotalBytesReadFromSource

withTotalLogicalBackupSizeBytes

withTotalPhysicalBackupSizeBytes

equals

hashCode

toString

copyOf

builder