ImmutableSourceBackupStatus (iland cloud Java SDK 1.0.45 API)

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

All Implemented Interfaces:: SourceBackupStatus

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

Immutable implementation of SourceBackupStatus.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableSourceBackupStatus.Builder
Builds instances of type ImmutableSourceBackupStatus.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableSourceBackupStatus.Builder`	`builder()` Creates a builder for `ImmutableSourceBackupStatus`.
`static ImmutableSourceBackupStatus`	`copyOf(SourceBackupStatus instance)` Creates an immutable copy of a `SourceBackupStatus` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableSourceBackupStatus` 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`, `isFullBackup`, `numRestarts`, `quiesced`, `slaViolated`, `source`, `stats`, `status`, `warnings`.
`boolean`	`isFullBackup()` Specifies whether this is a 'FULL' or 'REGULAR' backup of the Run.
`int`	`numRestarts()` Specifies the number of times the the task was restarted because of the changes on the backup source host.
`boolean`	`quiesced()` Specifies if app-consistent snapshot was captured.
`boolean`	`slaViolated()` Specifies if the SLA was violated for the backup group run.
`VCloudProtectionSource`	`source()` Specifies the vCloud protected source info.
`BackupSourceStats`	`stats()` Specifies statistics about a Backup task in backup group run.
`StatusSourceBackupStatus`	`status()` Specifies the status of the source object being protected.
`String`	`toString()` Prints the immutable value `SourceBackupStatus` with attribute values.
`com.google.common.collect.ImmutableSet<String>`	`warnings()` Array of Warnings.
`ImmutableSourceBackupStatus`	`withError(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `error` attribute.
`ImmutableSourceBackupStatus`	`withError(String value)` Copy the current immutable object by setting a present value for the optional `error` attribute.
`ImmutableSourceBackupStatus`	`withIsFullBackup(boolean value)` Copy the current immutable object by setting a value for the `isFullBackup` attribute.
`ImmutableSourceBackupStatus`	`withNumRestarts(int value)` Copy the current immutable object by setting a value for the `numRestarts` attribute.
`ImmutableSourceBackupStatus`	`withQuiesced(boolean value)` Copy the current immutable object by setting a value for the `quiesced` attribute.
`ImmutableSourceBackupStatus`	`withSlaViolated(boolean value)` Copy the current immutable object by setting a value for the `slaViolated` attribute.
`ImmutableSourceBackupStatus`	`withSource(VCloudProtectionSource value)` Copy the current immutable object by setting a value for the `source` attribute.
`ImmutableSourceBackupStatus`	`withStats(BackupSourceStats value)` Copy the current immutable object by setting a value for the `stats` attribute.
`ImmutableSourceBackupStatus`	`withStatus(StatusSourceBackupStatus value)` Copy the current immutable object by setting a value for the `status` attribute.
`ImmutableSourceBackupStatus`	`withWarnings(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `warnings`.
`ImmutableSourceBackupStatus`	`withWarnings(String... elements)` Copy the current immutable object with elements that replace the content of `warnings`.

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 SourceBackupStatus
  - isFullBackup
```
public boolean isFullBackup()
```
    Specifies whether this is a 'FULL' or 'REGULAR' backup of the Run. This may be true even if the scheduled backup type is 'REGULAR'. This will happen when this run corresponds to the first backup run of the group or if no previous snapshot information is found.
    
    Specified by:
    
    isFullBackup in interface SourceBackupStatus
  - numRestarts
```
public int numRestarts()
```
    Specifies the number of times the the task was restarted because of the changes on the backup source host.
    
    Specified by:
    
    numRestarts in interface SourceBackupStatus
  - quiesced
```
public boolean quiesced()
```
    Specifies if app-consistent snapshot was captured. This field is set to true, if an app-consistent snapshot was taken by quiescing applications and the file system before taking a backup.
    
    Specified by:
    
    quiesced in interface SourceBackupStatus
  - slaViolated
```
public boolean slaViolated()
```
    Specifies if the SLA was violated for the backup group run. This field is set to true, if time to complete the backup group run is longer than the SLA specified.
    
    Specified by:
    
    slaViolated in interface SourceBackupStatus
  - source
```
public VCloudProtectionSource source()
```
    Specifies the vCloud protected source info.
    
    Specified by:
    
    source in interface SourceBackupStatus
  - stats
```
public BackupSourceStats stats()
```
    Specifies statistics about a Backup task in backup group run. Specifies statistics for one backup task. One backup task is used to backup one source. This structure is also used to aggregate stats of backup tasks in a backup group run.
    
    Specified by:
    
    stats in interface SourceBackupStatus
  - status
```
public StatusSourceBackupStatus status()
```
    Specifies the status of the source object being protected.
    
    Specified by:
    
    status in interface SourceBackupStatus
  - warnings
```
public com.google.common.collect.ImmutableSet<String> warnings()
```
    Array of Warnings.
    Specifies the warnings that occurred (if any) while running this task.
    
    Specified by:
    
    warnings in interface SourceBackupStatus
  - withError
```
public final ImmutableSourceBackupStatus 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 ImmutableSourceBackupStatus 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
  - withIsFullBackup
```
public final ImmutableSourceBackupStatus withIsFullBackup(boolean value)
```
    Copy the current immutable object by setting a value for the isFullBackup attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isFullBackup
    
    Returns:
    
    A modified copy of the this object
  - withNumRestarts
```
public final ImmutableSourceBackupStatus withNumRestarts(int value)
```
    Copy the current immutable object by setting a value for the numRestarts attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for numRestarts
    
    Returns:
    
    A modified copy of the this object
  - withQuiesced
```
public final ImmutableSourceBackupStatus withQuiesced(boolean value)
```
    Copy the current immutable object by setting a value for the quiesced attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for quiesced
    
    Returns:
    
    A modified copy of the this object
  - withSlaViolated
```
public final ImmutableSourceBackupStatus withSlaViolated(boolean value)
```
    Copy the current immutable object by setting a value for the slaViolated attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for slaViolated
    
    Returns:
    
    A modified copy of the this object
  - withSource
```
public final ImmutableSourceBackupStatus 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 ImmutableSourceBackupStatus withStats(BackupSourceStats 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 ImmutableSourceBackupStatus withStatus(StatusSourceBackupStatus 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
  - withWarnings
```
public final ImmutableSourceBackupStatus withWarnings(String... elements)
```
    Copy the current immutable object with elements that replace the content of warnings.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withWarnings
```
public final ImmutableSourceBackupStatus withWarnings(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of warnings. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of warnings elements to set
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableSourceBackupStatus 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, isFullBackup, numRestarts, quiesced, slaViolated, source, stats, status, warnings.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value SourceBackupStatus with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableSourceBackupStatus copyOf(SourceBackupStatus instance)
```
    Creates an immutable copy of a SourceBackupStatus 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 SourceBackupStatus instance
  - builder
```
public static ImmutableSourceBackupStatus.Builder builder()
```
    Creates a builder for ImmutableSourceBackupStatus.
```
 ImmutableSourceBackupStatus.builder()
    .error(String) // optional error
    .isFullBackup(boolean) // required isFullBackup
    .numRestarts(int) // required numRestarts
    .quiesced(boolean) // required quiesced
    .slaViolated(boolean) // required slaViolated
    .source(com.iland.cohesity.iaas.backups.common.model.VCloudProtectionSource) // required source
    .stats(com.iland.cohesity.iaas.backups.backupgroups.api.model.BackupSourceStats) // required stats
    .status(com.iland.cohesity.iaas.backups.backupgroups.enums.StatusSourceBackupStatus) // required status
    .addWarnings|addAllWarnings(String) // warnings elements
    .build();
 
```
    Returns:
    
    A new ImmutableSourceBackupStatus builder

Class ImmutableSourceBackupStatus

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

error

isFullBackup

numRestarts

quiesced

slaViolated

source

stats

status

warnings

withError

withError

withIsFullBackup

withNumRestarts

withQuiesced

withSlaViolated

withSource

withStats

withStatus

withWarnings

withWarnings

equals

hashCode

toString

copyOf

builder