ImmutableCopyRun (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: CopyRun

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

Immutable implementation of CopyRun.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableCopyRun.Builder
Builds instances of type ImmutableCopyRun.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableCopyRun.Builder`	`builder()` Creates a builder for `ImmutableCopyRun`.
`static ImmutableCopyRun`	`copyOf(CopyRun instance)` Creates an immutable copy of a `CopyRun` value.
`com.google.common.collect.ImmutableList<CopySnapshotTaskStatus>`	`copySnapshotTasks()` Specifies the status information of each task that copies the snapshot taken for a backup source.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableCopyRun` that have equal attribute values.
`Optional<String>`	`error()` Specifies if an error occurred (if any) while running this task.
`Optional<Instant>`	`expiryTime()` Specifies expiry time of the copies of the snapshots in this backup group run.
`int`	`hashCode()` Computes a hash code from attributes: `copySnapshotTasks`, `error`, `expiryTime`, `runStartTime`, `stats`, `status`, `target`.
`Instant`	`runStartTime()` Specifies start time of the copy run.
`Optional<CopyRunStats>`	`stats()` Stats for one copy task or aggregated stats of a Copy Run in a backup group run.
`StatusCopyRun`	`status()` Specifies the aggregated status of copy tasks.
`SnapshotTargetSettings`	`target()` Specifies settings about a target where a copied snapshot is stored.
`String`	`toString()` Prints the immutable value `CopyRun` with attribute values.
`ImmutableCopyRun`	`withCopySnapshotTasks(CopySnapshotTaskStatus... elements)` Copy the current immutable object with elements that replace the content of `copySnapshotTasks`.
`ImmutableCopyRun`	`withCopySnapshotTasks(Iterable<? extends CopySnapshotTaskStatus> elements)` Copy the current immutable object with elements that replace the content of `copySnapshotTasks`.
`ImmutableCopyRun`	`withError(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `error` attribute.
`ImmutableCopyRun`	`withError(String value)` Copy the current immutable object by setting a present value for the optional `error` attribute.
`ImmutableCopyRun`	`withExpiryTime(Instant value)` Copy the current immutable object by setting a present value for the optional `expiryTime` attribute.
`ImmutableCopyRun`	`withExpiryTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `expiryTime` attribute.
`ImmutableCopyRun`	`withRunStartTime(Instant value)` Copy the current immutable object by setting a value for the `runStartTime` attribute.
`ImmutableCopyRun`	`withStats(CopyRunStats value)` Copy the current immutable object by setting a present value for the optional `stats` attribute.
`ImmutableCopyRun`	`withStats(Optional<? extends CopyRunStats> optional)` Copy the current immutable object by setting an optional value for the `stats` attribute.
`ImmutableCopyRun`	`withStatus(StatusCopyRun value)` Copy the current immutable object by setting a value for the `status` attribute.
`ImmutableCopyRun`	`withTarget(SnapshotTargetSettings value)` Copy the current immutable object by setting a value for the `target` attribute.

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

- Method Detail
  - copySnapshotTasks
```
public com.google.common.collect.ImmutableList<CopySnapshotTaskStatus> copySnapshotTasks()
```
    Specifies the status information of each task that copies the snapshot taken for a backup source.
    
    Specified by:
    
    copySnapshotTasks in interface CopyRun
  - error
```
public Optional<String> error()
```
    Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to 'FAILURE'.
    
    Specified by:
    
    error in interface CopyRun
  - expiryTime
```
public Optional<Instant> expiryTime()
```
    Specifies expiry time of the copies of the snapshots in this backup group run.
    
    Specified by:
    
    expiryTime in interface CopyRun
  - runStartTime
```
public Instant runStartTime()
```
    Specifies start time of the copy run.
    
    Specified by:
    
    runStartTime in interface CopyRun
  - stats
```
public Optional<CopyRunStats> stats()
```
    Stats for one copy task or aggregated stats of a Copy Run in a backup group run.
    
    Specified by:
    
    stats in interface CopyRun
  - status
```
public StatusCopyRun status()
```
    Specifies the aggregated status of copy tasks.
    
    Specified by:
    
    status in interface CopyRun
  - target
```
public SnapshotTargetSettings target()
```
    Specifies settings about a target where a copied snapshot is stored. A target can be offsite or an archival external target.
    
    Specified by:
    
    target in interface CopyRun
  - withCopySnapshotTasks
```
public final ImmutableCopyRun withCopySnapshotTasks(CopySnapshotTaskStatus... elements)
```
    Copy the current immutable object with elements that replace the content of copySnapshotTasks.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withCopySnapshotTasks
```
public final ImmutableCopyRun withCopySnapshotTasks(Iterable<? extends CopySnapshotTaskStatus> elements)
```
    Copy the current immutable object with elements that replace the content of copySnapshotTasks. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of copySnapshotTasks elements to set
    
    Returns:
    
    A modified copy of this object
  - withError
```
public final ImmutableCopyRun withError(String value)
```
    Copy the current immutable object by setting a present value for the optional error attribute.
    
    Parameters:
    
    value - The value for error
    
    Returns:
    
    A modified copy of this object
  - withError
```
public final ImmutableCopyRun withError(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the error attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for error
    
    Returns:
    
    A modified copy of this object
  - withExpiryTime
```
public final ImmutableCopyRun withExpiryTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional expiryTime attribute.
    
    Parameters:
    
    value - The value for expiryTime
    
    Returns:
    
    A modified copy of this object
  - withExpiryTime
```
public final ImmutableCopyRun withExpiryTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the expiryTime 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 expiryTime
    
    Returns:
    
    A modified copy of this object
  - withRunStartTime
```
public final ImmutableCopyRun withRunStartTime(Instant value)
```
    Copy the current immutable object by setting a value for the runStartTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for runStartTime
    
    Returns:
    
    A modified copy of the this object
  - withStats
```
public final ImmutableCopyRun withStats(CopyRunStats value)
```
    Copy the current immutable object by setting a present value for the optional stats attribute.
    
    Parameters:
    
    value - The value for stats
    
    Returns:
    
    A modified copy of this object
  - withStats
```
public final ImmutableCopyRun withStats(Optional<? extends CopyRunStats> optional)
```
    Copy the current immutable object by setting an optional value for the stats 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 stats
    
    Returns:
    
    A modified copy of this object
  - withStatus
```
public final ImmutableCopyRun withStatus(StatusCopyRun value)
```
    Copy the current immutable object by setting a value for the status attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for status
    
    Returns:
    
    A modified copy of the this object
  - withTarget
```
public final ImmutableCopyRun withTarget(SnapshotTargetSettings value)
```
    Copy the current immutable object by setting a value for the target attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for target
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableCopyRun 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: copySnapshotTasks, error, expiryTime, runStartTime, stats, status, target.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CopyRun with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableCopyRun copyOf(CopyRun instance)
```
    Creates an immutable copy of a CopyRun 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 CopyRun instance
  - builder
```
public static ImmutableCopyRun.Builder builder()
```
    Creates a builder for ImmutableCopyRun.
```
 ImmutableCopyRun.builder()
    .addCopySnapshotTasks|addAllCopySnapshotTasks(com.iland.cohesity.iaas.backups.backupgroups.api.model.CopySnapshotTaskStatus) // copySnapshotTasks elements
    .error(String) // optional error
    .expiryTime(java.time.Instant) // optional expiryTime
    .runStartTime(java.time.Instant) // required runStartTime
    .stats(com.iland.cohesity.iaas.backups.backupgroups.api.model.CopyRunStats) // optional stats
    .status(com.iland.cohesity.iaas.backups.backupgroups.enums.StatusCopyRun) // required status
    .target(com.iland.cohesity.iaas.backups.backupgroups.api.model.SnapshotTargetSettings) // required target
    .build();
 
```
    Returns:
    
    A new ImmutableCopyRun builder

Class ImmutableCopyRun

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copySnapshotTasks

error

expiryTime

runStartTime

stats

status

target

withCopySnapshotTasks

withCopySnapshotTasks

withError

withError

withExpiryTime

withExpiryTime

withRunStartTime

withStats

withStats

withStatus

withTarget

equals

hashCode

toString

copyOf

builder