ImmutableCopySnapshotTaskStatus (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: CopySnapshotTaskStatus

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

Immutable implementation of CopySnapshotTaskStatus.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableCopySnapshotTaskStatus.Builder
Builds instances of type ImmutableCopySnapshotTaskStatus.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableCopySnapshotTaskStatus.Builder`	`builder()` Creates a builder for `ImmutableCopySnapshotTaskStatus`.
`static ImmutableCopySnapshotTaskStatus`	`copyOf(CopySnapshotTaskStatus instance)` Creates an immutable copy of a `CopySnapshotTaskStatus` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableCopySnapshotTaskStatus` that have equal attribute values.
`Optional<String>`	`error()` Specifies if an error occurred (if any) while running this task.
`int`	`hashCode()` Computes a hash code from attributes: `error`, `source`, `stats`, `status`, `taskEndTime`, `taskStartTime`.
`VCloudProtectionSource`	`source()` Identifies the vCloud protection source details.
`CopyRunStats`	`stats()` Stats for the copy task.
`StatusCopySnapshotTaskStatus`	`status()` Specifies the status of the source object being protected.
`Optional<Instant>`	`taskEndTime()` Specifies the end time of the copy task.
`Instant`	`taskStartTime()` Specifies the start time of the copy task.
`String`	`toString()` Prints the immutable value `CopySnapshotTaskStatus` with attribute values.
`ImmutableCopySnapshotTaskStatus`	`withError(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `error` attribute.
`ImmutableCopySnapshotTaskStatus`	`withError(String value)` Copy the current immutable object by setting a present value for the optional `error` attribute.
`ImmutableCopySnapshotTaskStatus`	`withSource(VCloudProtectionSource value)` Copy the current immutable object by setting a value for the `source` attribute.
`ImmutableCopySnapshotTaskStatus`	`withStats(CopyRunStats value)` Copy the current immutable object by setting a value for the `stats` attribute.
`ImmutableCopySnapshotTaskStatus`	`withStatus(StatusCopySnapshotTaskStatus value)` Copy the current immutable object by setting a value for the `status` attribute.
`ImmutableCopySnapshotTaskStatus`	`withTaskEndTime(Instant value)` Copy the current immutable object by setting a present value for the optional `taskEndTime` attribute.
`ImmutableCopySnapshotTaskStatus`	`withTaskEndTime(Optional<? extends Instant> optional)` Copy the current immutable object by setting an optional value for the `taskEndTime` attribute.
`ImmutableCopySnapshotTaskStatus`	`withTaskStartTime(Instant value)` Copy the current immutable object by setting a value for the `taskStartTime` attribute.

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

- Method Detail
  - 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 CopySnapshotTaskStatus
  - source
```
public VCloudProtectionSource source()
```
    Identifies the vCloud protection source details.
    
    Specified by:
    
    source in interface CopySnapshotTaskStatus
  - stats
```
public CopyRunStats stats()
```
    Stats for the copy task.
    
    Specified by:
    
    stats in interface CopySnapshotTaskStatus
  - status
```
public StatusCopySnapshotTaskStatus status()
```
    Specifies the status of the source object being protected.
    
    Specified by:
    
    status in interface CopySnapshotTaskStatus
  - taskEndTime
```
public Optional<Instant> taskEndTime()
```
    Specifies the end time of the copy task.
    
    Specified by:
    
    taskEndTime in interface CopySnapshotTaskStatus
  - taskStartTime
```
public Instant taskStartTime()
```
    Specifies the start time of the copy task. Copy run task is started after completing backup tasks. It may spawn sub-tasks to copy or replicate individual snapshots.
    
    Specified by:
    
    taskStartTime in interface CopySnapshotTaskStatus
  - withError
```
public final ImmutableCopySnapshotTaskStatus 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 ImmutableCopySnapshotTaskStatus 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
  - withSource
```
public final ImmutableCopySnapshotTaskStatus withSource(VCloudProtectionSource value)
```
    Copy the current immutable object by setting a value for the source attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for source
    
    Returns:
    
    A modified copy of the this object
  - withStats
```
public final ImmutableCopySnapshotTaskStatus withStats(CopyRunStats value)
```
    Copy the current immutable object by setting a value for the stats attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for stats
    
    Returns:
    
    A modified copy of the this object
  - withStatus
```
public final ImmutableCopySnapshotTaskStatus withStatus(StatusCopySnapshotTaskStatus 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
  - withTaskEndTime
```
public final ImmutableCopySnapshotTaskStatus withTaskEndTime(Instant value)
```
    Copy the current immutable object by setting a present value for the optional taskEndTime attribute.
    
    Parameters:
    
    value - The value for taskEndTime
    
    Returns:
    
    A modified copy of this object
  - withTaskEndTime
```
public final ImmutableCopySnapshotTaskStatus withTaskEndTime(Optional<? extends Instant> optional)
```
    Copy the current immutable object by setting an optional value for the taskEndTime 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 taskEndTime
    
    Returns:
    
    A modified copy of this object
  - withTaskStartTime
```
public final ImmutableCopySnapshotTaskStatus withTaskStartTime(Instant value)
```
    Copy the current immutable object by setting a value for the taskStartTime attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for taskStartTime
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableCopySnapshotTaskStatus 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: error, source, stats, status, taskEndTime, taskStartTime.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value CopySnapshotTaskStatus with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableCopySnapshotTaskStatus copyOf(CopySnapshotTaskStatus instance)
```
    Creates an immutable copy of a CopySnapshotTaskStatus 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 CopySnapshotTaskStatus instance
  - builder
```
public static ImmutableCopySnapshotTaskStatus.Builder builder()
```
    Creates a builder for ImmutableCopySnapshotTaskStatus.
```
 ImmutableCopySnapshotTaskStatus.builder()
    .error(String) // optional error
    .source(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSource) // required source
    .stats(com.iland.cohesity.iaas.backups.backupgroups.api.model.CopyRunStats) // required stats
    .status(com.iland.cohesity.iaas.backups.backupgroups.enums.StatusCopySnapshotTaskStatus) // required status
    .taskEndTime(java.time.Instant) // optional taskEndTime
    .taskStartTime(java.time.Instant) // required taskStartTime
    .build();
 
```
    Returns:
    
    A new ImmutableCopySnapshotTaskStatus builder

Class ImmutableCopySnapshotTaskStatus

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

error

source

stats

status

taskEndTime

taskStartTime

withError

withError

withSource

withStats

withStatus

withTaskEndTime

withTaskEndTime

withTaskStartTime

equals

hashCode

toString

copyOf

builder