ImmutableSnapshotVersion (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: SnapshotVersion

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

Immutable implementation of SnapshotVersion.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSnapshotVersion.Builder
Builds instances of type ImmutableSnapshotVersion.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`appConsistent()` Specifies if an app-consistent snapshot was captured.
`long`	`attemptNumber()` Specifies the number of the attempts made by the VCloudProtectionJob Run to capture a snapshot of the object.
`BackupRunUid`	`backupRunUid()` Specifies the id of the backup run.
`static ImmutableSnapshotVersion.Builder`	`builder()` Creates a builder for `ImmutableSnapshotVersion`.
`static ImmutableSnapshotVersion`	`copyOf(SnapshotVersion instance)` Creates an immutable copy of a `SnapshotVersion` value.
`long`	`deltaSizeBytes()` Specifies the size of the data captured from the source object.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSnapshotVersion` that have equal attribute values.
`boolean`	`fullBackup()` Specifies if the snapshot is a full backup.
`int`	`hashCode()` Computes a hash code from attributes: `startTime`, `attemptNumber`, `deltaSizeBytes`, `appConsistent`, `fullBackup`, `backupRunUid`, `logicalSizeBytes`, `physicalSizeBytes`, `primaryPhysicalSizeBytes`.
`long`	`logicalSizeBytes()` Specifies the size of the snapshot if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication.
`long`	`physicalSizeBytes()` Specifies the amount of data actually used on the disk to store this object after being reduced by change-block tracking, compression and deduplication.
`long`	`primaryPhysicalSizeBytes()` Specifies the total amount of disk space used to store this object on the primary storage.
`Instant`	`startTime()` The time that the snapshot was captured.
`String`	`toString()` Prints the immutable value `SnapshotVersion` with attribute values.
`ImmutableSnapshotVersion`	`withAppConsistent(boolean value)` Copy the current immutable object by setting a value for the `appConsistent` attribute.
`ImmutableSnapshotVersion`	`withAttemptNumber(long value)` Copy the current immutable object by setting a value for the `attemptNumber` attribute.
`ImmutableSnapshotVersion`	`withBackupRunUid(BackupRunUid value)` Copy the current immutable object by setting a value for the `backupRunUid` attribute.
`ImmutableSnapshotVersion`	`withDeltaSizeBytes(long value)` Copy the current immutable object by setting a value for the `deltaSizeBytes` attribute.
`ImmutableSnapshotVersion`	`withFullBackup(boolean value)` Copy the current immutable object by setting a value for the `fullBackup` attribute.
`ImmutableSnapshotVersion`	`withLogicalSizeBytes(long value)` Copy the current immutable object by setting a value for the `logicalSizeBytes` attribute.
`ImmutableSnapshotVersion`	`withPhysicalSizeBytes(long value)` Copy the current immutable object by setting a value for the `physicalSizeBytes` attribute.
`ImmutableSnapshotVersion`	`withPrimaryPhysicalSizeBytes(long value)` Copy the current immutable object by setting a value for the `primaryPhysicalSizeBytes` attribute.
`ImmutableSnapshotVersion`	`withStartTime(Instant value)` Copy the current immutable object by setting a value for the `startTime` attribute.

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

- Method Detail
  - startTime
```
public Instant startTime()
```
    The time that the snapshot was captured.
    
    Specified by:
    
    startTime in interface SnapshotVersion
  - attemptNumber
```
public long attemptNumber()
```
    Specifies the number of the attempts made by the VCloudProtectionJob Run to capture a snapshot of the object. For example, if an snapshot is successfully captured after three attempts, this field equals 3.
    
    Specified by:
    
    attemptNumber in interface SnapshotVersion
  - deltaSizeBytes
```
public long deltaSizeBytes()
```
    Specifies the size of the data captured from the source object. For a full backup (where Change Block Tracking is not utilized) this field is equal to logicalSizeBytes. For an incremental backup (where Change Block Tracking is utilized), this field specifies the size of the data that has changed since the last backup.
    
    Specified by:
    
    deltaSizeBytes in interface SnapshotVersion
  - appConsistent
```
public boolean appConsistent()
```
    Specifies if an app-consistent snapshot was captured. For example, was the VM was quiesced before the snapshot was captured.
    
    Specified by:
    
    appConsistent in interface SnapshotVersion
  - fullBackup
```
public boolean fullBackup()
```
    Specifies if the snapshot is a full backup. For example, all blocks of the VM is captured and Change Block Tracking is not utilized.
    
    Specified by:
    
    fullBackup in interface SnapshotVersion
  - backupRunUid
```
public BackupRunUid backupRunUid()
```
    Specifies the id of the backup run.
    
    Specified by:
    
    backupRunUid in interface SnapshotVersion
  - logicalSizeBytes
```
public long logicalSizeBytes()
```
    Specifies the size of the snapshot if the data is fully hydrated or expanded and not reduced by change-block tracking, compression and deduplication. For example if a VMDK of size 100GB is created with thin provisioning and the disk size to store the VMDK is 20GB. The logical size of this object is 100GB and the physical size is 20GB.
    
    Specified by:
    
    logicalSizeBytes in interface SnapshotVersion
  - physicalSizeBytes
```
public long physicalSizeBytes()
```
    Specifies the amount of data actually used on the disk to store this object after being reduced by change-block tracking, compression and deduplication.
    
    Specified by:
    
    physicalSizeBytes in interface SnapshotVersion
  - primaryPhysicalSizeBytes
```
public long primaryPhysicalSizeBytes()
```
    Specifies the total amount of disk space used to store this object on the primary storage. For example the total amount of disk space used to store the VM files (such as the VMDK files) on the primary datastore.
    
    Specified by:
    
    primaryPhysicalSizeBytes in interface SnapshotVersion
  - withStartTime
```
public final ImmutableSnapshotVersion 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
  - withAttemptNumber
```
public final ImmutableSnapshotVersion withAttemptNumber(long value)
```
    Copy the current immutable object by setting a value for the attemptNumber attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for attemptNumber
    
    Returns:
    
    A modified copy of the this object
  - withDeltaSizeBytes
```
public final ImmutableSnapshotVersion withDeltaSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the deltaSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for deltaSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - withAppConsistent
```
public final ImmutableSnapshotVersion withAppConsistent(boolean value)
```
    Copy the current immutable object by setting a value for the appConsistent attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for appConsistent
    
    Returns:
    
    A modified copy of the this object
  - withFullBackup
```
public final ImmutableSnapshotVersion withFullBackup(boolean value)
```
    Copy the current immutable object by setting a value for the fullBackup attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for fullBackup
    
    Returns:
    
    A modified copy of the this object
  - withBackupRunUid
```
public final ImmutableSnapshotVersion withBackupRunUid(BackupRunUid value)
```
    Copy the current immutable object by setting a value for the backupRunUid attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for backupRunUid
    
    Returns:
    
    A modified copy of the this object
  - withLogicalSizeBytes
```
public final ImmutableSnapshotVersion withLogicalSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the logicalSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for logicalSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - withPhysicalSizeBytes
```
public final ImmutableSnapshotVersion withPhysicalSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the physicalSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for physicalSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - withPrimaryPhysicalSizeBytes
```
public final ImmutableSnapshotVersion withPrimaryPhysicalSizeBytes(long value)
```
    Copy the current immutable object by setting a value for the primaryPhysicalSizeBytes attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for primaryPhysicalSizeBytes
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableSnapshotVersion 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: startTime, attemptNumber, deltaSizeBytes, appConsistent, fullBackup, backupRunUid, logicalSizeBytes, physicalSizeBytes, primaryPhysicalSizeBytes.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SnapshotVersion with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSnapshotVersion copyOf(SnapshotVersion instance)
```
    Creates an immutable copy of a SnapshotVersion 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 SnapshotVersion instance
  - builder
```
public static ImmutableSnapshotVersion.Builder builder()
```
    Creates a builder for ImmutableSnapshotVersion.
```
 ImmutableSnapshotVersion.builder()
    .startTime(java.time.Instant) // required startTime
    .attemptNumber(long) // required attemptNumber
    .deltaSizeBytes(long) // required deltaSizeBytes
    .appConsistent(boolean) // required appConsistent
    .fullBackup(boolean) // required fullBackup
    .backupRunUid(com.iland.cohesity.iaas.backups.common.model.BackupRunUid) // required backupRunUid
    .logicalSizeBytes(long) // required logicalSizeBytes
    .physicalSizeBytes(long) // required physicalSizeBytes
    .primaryPhysicalSizeBytes(long) // required primaryPhysicalSizeBytes
    .build();
 
```
    Returns:
    
    A new ImmutableSnapshotVersion builder

Class ImmutableSnapshotVersion

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

startTime

attemptNumber

deltaSizeBytes

appConsistent

fullBackup

backupRunUid

logicalSizeBytes

physicalSizeBytes

primaryPhysicalSizeBytes

withStartTime

withAttemptNumber

withDeltaSizeBytes

withAppConsistent

withFullBackup

withBackupRunUid

withLogicalSizeBytes

withPhysicalSizeBytes

withPrimaryPhysicalSizeBytes

equals

hashCode

toString

copyOf

builder