ImmutableBackupSourceStats (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.backupgroups.api.model.ImmutableBackupSourceStats

All Implemented Interfaces:: BackupSourceStats

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

Immutable implementation of BackupSourceStats.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableBackupSourceStats.Builder
Builds instances of type ImmutableBackupSourceStats.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<Instant>`	`admittedTime()` Specifies the time the task was unqueued from the queue to start running.
`static ImmutableBackupSourceStats.Builder`	`builder()` Creates a builder for `ImmutableBackupSourceStats`.
`static ImmutableBackupSourceStats`	`copyOf(BackupSourceStats instance)` Creates an immutable copy of a `BackupSourceStats` value.
`Optional<Instant>`	`endTime()` Specifies the end time of the backup run.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableBackupSourceStats` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `admittedTime`, `endTime`, `startTime`, `timeTaken`, `totalBytesReadFromSource`, `totalBytesToReadFromSource`, `totalLogicalBackupSizeBytes`, `totalPhysicalBackupSizeBytes`, `totalSourceSizeBytes`.
`Instant`	`startTime()` Specifies the start time of the Protection Run.
`Optional<Duration>`	`timeTaken()` Specifies the actual execution time for the protection run to complete the backup task and the copy tasks.
`String`	`toString()` Prints the immutable value `BackupSourceStats` with attribute values.
`long`	`totalBytesReadFromSource()` Specifies the total amount of data read from the source (so far).
`long`	`totalBytesToReadFromSource()` Specifies the total amount of data expected to be read from the source.
`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.
`long`	`totalSourceSizeBytes()` Specifies the size of the source object (such as a VM) protected by this task on the primary storage before the snapshot is taken.
`ImmutableBackupSourceStats`	`withAdmittedTime(Instant value)` Copy the current immutable object by setting a present value for the optional `admittedTime` attribute.
`ImmutableBackupSourceStats`	`withAdmittedTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `admittedTime` attribute.
`ImmutableBackupSourceStats`	`withEndTime(Instant value)` Copy the current immutable object by setting a present value for the optional `endTime` attribute.
`ImmutableBackupSourceStats`	`withEndTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `endTime` attribute.
`ImmutableBackupSourceStats`	`withStartTime(Instant value)` Copy the current immutable object by setting a value for the `startTime` attribute.
`ImmutableBackupSourceStats`	`withTimeTaken(Duration value)` Copy the current immutable object by setting a present value for the optional `timeTaken` attribute.
`ImmutableBackupSourceStats`	`withTimeTaken(Optional<? extends Duration> optional)` Copy the current immutable object by setting an optional value for the `timeTaken` attribute.
`ImmutableBackupSourceStats`	`withTotalBytesReadFromSource(long value)` Copy the current immutable object by setting a value for the `totalBytesReadFromSource` attribute.
`ImmutableBackupSourceStats`	`withTotalBytesToReadFromSource(long value)` Copy the current immutable object by setting a value for the `totalBytesToReadFromSource` attribute.
`ImmutableBackupSourceStats`	`withTotalLogicalBackupSizeBytes(long value)` Copy the current immutable object by setting a value for the `totalLogicalBackupSizeBytes` attribute.
`ImmutableBackupSourceStats`	`withTotalPhysicalBackupSizeBytes(long value)` Copy the current immutable object by setting a value for the `totalPhysicalBackupSizeBytes` attribute.
`ImmutableBackupSourceStats`	`withTotalSourceSizeBytes(long value)` Copy the current immutable object by setting a value for the `totalSourceSizeBytes` attribute.

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

- Method Detail
  - admittedTime
```
public Optional<Instant> admittedTime()
```
    Specifies the time the task was unqueued from the queue to start running. This field can be used to determine the following times: initial-wait-time = admittedTimeUsecs - startTimeUsecs run-time = endTimeUsecs - admittedTimeUsecs If the task ends up waiting in other queues, then actual run-time will be smaller than the run-time computed this way.
    
    Specified by:
    
    admittedTime in interface BackupSourceStats
  - endTime
```
public Optional<Instant> endTime()
```
    Specifies the end time of the backup run.
    
    Specified by:
    
    endTime in interface BackupSourceStats
  - startTime
```
public Instant startTime()
```
    Specifies the start time of the Protection Run. This time is when the task is queued to an internal queue where tasks are waiting to run.
    
    Specified by:
    
    startTime in interface BackupSourceStats
  - timeTaken
```
public Optional<Duration> timeTaken()
```
    Specifies the actual execution time for the protection run to complete the backup task and the copy tasks. This time will not include the time waited in various internal queues.
    
    Specified by:
    
    timeTaken in interface BackupSourceStats
  - totalBytesReadFromSource
```
public long totalBytesReadFromSource()
```
    Specifies the total amount of data read from the source (so far).
    
    Specified by:
    
    totalBytesReadFromSource in interface BackupSourceStats
  - totalBytesToReadFromSource
```
public long totalBytesToReadFromSource()
```
    Specifies the total amount of data expected to be read from the source.
    
    Specified by:
    
    totalBytesToReadFromSource in interface BackupSourceStats
  - 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 BackupSourceStats
  - 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 BackupSourceStats
  - totalSourceSizeBytes
```
public long totalSourceSizeBytes()
```
    Specifies the size of the source object (such as a VM) protected by this task on the primary storage before 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:
    
    totalSourceSizeBytes in interface BackupSourceStats
  - withAdmittedTime
```
public final ImmutableBackupSourceStats withAdmittedTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional admittedTime attribute.
    
    Parameters:
    
    value - The value for admittedTime
    
    Returns:
    
    A modified copy of this object
  - withAdmittedTime
```
public final ImmutableBackupSourceStats withAdmittedTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the admittedTime 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 admittedTime
    
    Returns:
    
    A modified copy of this object
  - withEndTime
```
public final ImmutableBackupSourceStats withEndTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional endTime attribute.
    
    Parameters:
    
    value - The value for endTime
    
    Returns:
    
    A modified copy of this object
  - withEndTime
```
public final ImmutableBackupSourceStats withEndTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the endTime 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 endTime
    
    Returns:
    
    A modified copy of this object
  - withStartTime
```
public final ImmutableBackupSourceStats withStartTime(Instant value)
```
    Copy the current immutable object by setting a value for the startTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for startTime
    
    Returns:
    
    A modified copy of the this object
  - withTimeTaken
```
public final ImmutableBackupSourceStats withTimeTaken(Duration value)
```
    Copy the current immutable object by setting a present value for the optional timeTaken attribute.
    
    Parameters:
    
    value - The value for timeTaken
    
    Returns:
    
    A modified copy of this object
  - withTimeTaken
```
public final ImmutableBackupSourceStats withTimeTaken(Optional<? extends Duration> optional)
```
    Copy the current immutable object by setting an optional value for the timeTaken 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 timeTaken
    
    Returns:
    
    A modified copy of this object
  - withTotalBytesReadFromSource
```
public final ImmutableBackupSourceStats 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
  - withTotalBytesToReadFromSource
```
public final ImmutableBackupSourceStats withTotalBytesToReadFromSource(long value)
```
    Copy the current immutable object by setting a value for the totalBytesToReadFromSource attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalBytesToReadFromSource
    
    Returns:
    
    A modified copy of the this object
  - withTotalLogicalBackupSizeBytes
```
public final ImmutableBackupSourceStats 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 ImmutableBackupSourceStats 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
  - withTotalSourceSizeBytes
```
public final ImmutableBackupSourceStats withTotalSourceSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the totalSourceSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for totalSourceSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableBackupSourceStats 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: admittedTime, endTime, startTime, timeTaken, totalBytesReadFromSource, totalBytesToReadFromSource, totalLogicalBackupSizeBytes, totalPhysicalBackupSizeBytes, totalSourceSizeBytes.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value BackupSourceStats with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableBackupSourceStats copyOf(BackupSourceStats instance)
```
    Creates an immutable copy of a BackupSourceStats 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 BackupSourceStats instance
  - builder
```
public static ImmutableBackupSourceStats.Builder builder()
```
    Creates a builder for ImmutableBackupSourceStats.
```
 ImmutableBackupSourceStats.builder()
    .admittedTime(java.time.Instant) // optional admittedTime
    .endTime(java.time.Instant) // optional endTime
    .startTime(java.time.Instant) // required startTime
    .timeTaken(java.time.Duration) // optional timeTaken
    .totalBytesReadFromSource(long) // required totalBytesReadFromSource
    .totalBytesToReadFromSource(long) // required totalBytesToReadFromSource
    .totalLogicalBackupSizeBytes(long) // required totalLogicalBackupSizeBytes
    .totalPhysicalBackupSizeBytes(long) // required totalPhysicalBackupSizeBytes
    .totalSourceSizeBytes(long) // required totalSourceSizeBytes
    .build();
 
```
    Returns:
    
    A new ImmutableBackupSourceStats builder

Class ImmutableBackupSourceStats

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

admittedTime

endTime

startTime

timeTaken

totalBytesReadFromSource

totalBytesToReadFromSource

totalLogicalBackupSizeBytes

totalPhysicalBackupSizeBytes

totalSourceSizeBytes

withAdmittedTime

withAdmittedTime

withEndTime

withEndTime

withStartTime

withTimeTaken

withTimeTaken

withTotalBytesReadFromSource

withTotalBytesToReadFromSource

withTotalLogicalBackupSizeBytes

withTotalPhysicalBackupSizeBytes

withTotalSourceSizeBytes

equals

hashCode

toString

copyOf

builder