com.iland.cohesity.iaas.backups.backupgroups.api.model

Class ImmutableBackupRun

java.lang.Object

com.iland.cohesity.iaas.backups.backupgroups.api.model.ImmutableBackupRun

All Implemented Interfaces:

BackupRun

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

Immutable implementation of BackupRun.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableBackupRun.Builder Builds instances of type ImmutableBackupRun.

Method Summary

Modifier and Type	Method and Description
static ImmutableBackupRun.Builder	builder() Creates a builder for ImmutableBackupRun.
static ImmutableBackupRun	copyOf(BackupRun instance) Creates an immutable copy of a BackupRun value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableBackupRun that have equal attribute values.
Optional<String>	errorMessage() Specifies if an error occurred (if any) while running this task.
int	hashCode() Computes a hash code from attributes: errorMessage, successMessage, metadataDeleted, quiesced, runType, slaViolated, snapshotsDeleted, snapshotsDeletedTime, sourceBackupStatus, stats, status, warnings.
boolean	metadataDeleted() Specifies if the metadata and snapshots associated with this backup group run have been deleted.
boolean	quiesced() Specifies if app-consistent snapshot was captured.
RunType	runType() Specifies the type of backup.
Optional<Boolean>	slaViolated() Specifies if the SLA was violated for the backup group run.
boolean	snapshotsDeleted() Specifies if backup snapshots associated with this backup group run have been marked for deletion because of the retention settings in the policy or if they were manually deleted.
Optional<Instant>	snapshotsDeletedTime() Specifies the time that snapshots were deleted.
com.google.common.collect.ImmutableSet<SourceBackupStatus>	sourceBackupStatus() Array of Source Object Backup Status.
BackupRunStats	stats() Specifies statistics about a backup group run.
StatusBackupRun	status() Specifies the status of Backup task.
Optional<String>	successMessage() Specifies a message after finishing the task successfully.
String	toString() Prints the immutable value BackupRun with attribute values.
com.google.common.collect.ImmutableList<String>	warnings() Array of Warnings.
ImmutableBackupRun	withErrorMessage(Optional<String> optional) Copy the current immutable object by setting an optional value for the errorMessage attribute.
ImmutableBackupRun	withErrorMessage(String value) Copy the current immutable object by setting a present value for the optional errorMessage attribute.
ImmutableBackupRun	withMetadataDeleted(boolean value) Copy the current immutable object by setting a value for the metadataDeleted attribute.
ImmutableBackupRun	withQuiesced(boolean value) Copy the current immutable object by setting a value for the quiesced attribute.
ImmutableBackupRun	withRunType(RunType value) Copy the current immutable object by setting a value for the runType attribute.
ImmutableBackupRun	withSlaViolated(boolean value) Copy the current immutable object by setting a present value for the optional slaViolated attribute.
ImmutableBackupRun	withSlaViolated(Optional<Boolean> optional) Copy the current immutable object by setting an optional value for the slaViolated attribute.
ImmutableBackupRun	withSnapshotsDeleted(boolean value) Copy the current immutable object by setting a value for the snapshotsDeleted attribute.
ImmutableBackupRun	withSnapshotsDeletedTime(Instant value) Copy the current immutable object by setting a present value for the optional snapshotsDeletedTime attribute.
ImmutableBackupRun	withSnapshotsDeletedTime(Optional<? extends Instant> optional) Copy the current immutable object by setting an optional value for the snapshotsDeletedTime attribute.
ImmutableBackupRun	withSourceBackupStatus(Iterable<? extends SourceBackupStatus> elements) Copy the current immutable object with elements that replace the content of sourceBackupStatus.
ImmutableBackupRun	withSourceBackupStatus(SourceBackupStatus... elements) Copy the current immutable object with elements that replace the content of sourceBackupStatus.
ImmutableBackupRun	withStats(BackupRunStats value) Copy the current immutable object by setting a value for the stats attribute.
ImmutableBackupRun	withStatus(StatusBackupRun value) Copy the current immutable object by setting a value for the status attribute.
ImmutableBackupRun	withSuccessMessage(Optional<String> optional) Copy the current immutable object by setting an optional value for the successMessage attribute.
ImmutableBackupRun	withSuccessMessage(String value) Copy the current immutable object by setting a present value for the optional successMessage attribute.
ImmutableBackupRun	withWarnings(Iterable<String> elements) Copy the current immutable object with elements that replace the content of warnings.
ImmutableBackupRun	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

errorMessage

public Optional<String> errorMessage()

Specifies if an error occurred (if any) while running this task. This field is populated when the status is equal to 'FAILURE'.

Specified by:

errorMessage in interface BackupRun

successMessage

public Optional<String> successMessage()

Specifies a message after finishing the task successfully. This field is optionally populated when the status is equal to SUCCESS'.

Specified by:

successMessage in interface BackupRun

metadataDeleted

public boolean metadataDeleted()

Specifies if the metadata and snapshots associated with this backup group run have been deleted. This field is set to true when the snapshots, which are marked for deletion, are removed by garbage collection. The associated metadata is also deleted.

Specified by:

metadataDeleted in interface BackupRun

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 BackupRun

runType

public RunType runType()

Specifies the type of backup.

Specified by:

runType in interface BackupRun

slaViolated

public Optional<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. This field is populated when the status is set to 'SUCCESS' or 'FAILURE'.

Specified by:

slaViolated in interface BackupRun

snapshotsDeleted

public boolean snapshotsDeleted()

Specifies if backup snapshots associated with this backup group run have been marked for deletion because of the retention settings in the policy or if they were manually deleted.

Specified by:

snapshotsDeleted in interface BackupRun

snapshotsDeletedTime

public Optional<Instant> snapshotsDeletedTime()

Specifies the time that snapshots were deleted.

Specified by:

snapshotsDeletedTime in interface BackupRun

sourceBackupStatus

public com.google.common.collect.ImmutableSet<SourceBackupStatus> sourceBackupStatus()

Array of Source Object Backup Status.

Specifies the status of backing up each source objects (such as VMs) associated with the backup group run.

Specified by:

sourceBackupStatus in interface BackupRun

stats

public BackupRunStats stats()

Specifies statistics about a backup group run. This contains the backup group run level statistics.

Specified by:

stats in interface BackupRun

status

public StatusBackupRun status()

Specifies the status of Backup task.

Specified by:

status in interface BackupRun

warnings

public com.google.common.collect.ImmutableList<String> warnings()

Array of Warnings.

Specifies the warnings that occurred (if any) while running this task.

Specified by:

warnings in interface BackupRun

withErrorMessage

public final ImmutableBackupRun withErrorMessage(String value)

Copy the current immutable object by setting a present value for the optional errorMessage attribute.

Parameters:

value - The value for errorMessage

Returns:

A modified copy of this object

withErrorMessage

public final ImmutableBackupRun withErrorMessage(Optional<String> optional)

Copy the current immutable object by setting an optional value for the errorMessage 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 errorMessage

Returns:

A modified copy of this object

withSuccessMessage

public final ImmutableBackupRun withSuccessMessage(String value)

Copy the current immutable object by setting a present value for the optional successMessage attribute.

Parameters:

value - The value for successMessage

Returns:

A modified copy of this object

withSuccessMessage

public final ImmutableBackupRun withSuccessMessage(Optional<String> optional)

Copy the current immutable object by setting an optional value for the successMessage 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 successMessage

Returns:

A modified copy of this object

withMetadataDeleted

public final ImmutableBackupRun withMetadataDeleted(boolean value)

Copy the current immutable object by setting a value for the metadataDeleted attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for metadataDeleted

Returns:

A modified copy of the this object

withQuiesced

public final ImmutableBackupRun 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

withRunType

public final ImmutableBackupRun withRunType(RunType value)

Copy the current immutable object by setting a value for the runType attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for runType

Returns:

A modified copy of the this object

withSlaViolated

public final ImmutableBackupRun withSlaViolated(boolean value)

Copy the current immutable object by setting a present value for the optional slaViolated attribute.

Parameters:

value - The value for slaViolated

Returns:

A modified copy of this object

withSlaViolated

public final ImmutableBackupRun withSlaViolated(Optional<Boolean> optional)

Copy the current immutable object by setting an optional value for the slaViolated 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 slaViolated

Returns:

A modified copy of this object

withSnapshotsDeleted

public final ImmutableBackupRun withSnapshotsDeleted(boolean value)

Copy the current immutable object by setting a value for the snapshotsDeleted attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for snapshotsDeleted

Returns:

A modified copy of the this object

withSnapshotsDeletedTime

public final ImmutableBackupRun withSnapshotsDeletedTime(Instant value)

Copy the current immutable object by setting a present value for the optional snapshotsDeletedTime attribute.

Parameters:

value - The value for snapshotsDeletedTime

Returns:

A modified copy of this object

withSnapshotsDeletedTime

public final ImmutableBackupRun withSnapshotsDeletedTime(Optional<? extends Instant> optional)

Copy the current immutable object by setting an optional value for the snapshotsDeletedTime 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 snapshotsDeletedTime

Returns:

A modified copy of this object

withSourceBackupStatus

public final ImmutableBackupRun withSourceBackupStatus(SourceBackupStatus... elements)

Copy the current immutable object with elements that replace the content of sourceBackupStatus.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSourceBackupStatus

public final ImmutableBackupRun withSourceBackupStatus(Iterable<? extends SourceBackupStatus> elements)

Copy the current immutable object with elements that replace the content of sourceBackupStatus. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of sourceBackupStatus elements to set

Returns:

A modified copy of this object

withStats

public final ImmutableBackupRun withStats(BackupRunStats 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 ImmutableBackupRun withStatus(StatusBackupRun 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 ImmutableBackupRun 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 ImmutableBackupRun 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 ImmutableBackupRun 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: errorMessage, successMessage, metadataDeleted, quiesced, runType, slaViolated, snapshotsDeleted, snapshotsDeletedTime, sourceBackupStatus, stats, status, warnings.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value BackupRun with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBackupRun copyOf(BackupRun instance)

Creates an immutable copy of a BackupRun 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 BackupRun instance

builder

public static ImmutableBackupRun.Builder builder()

Creates a builder for ImmutableBackupRun.

 ImmutableBackupRun.builder()
    .errorMessage(String) // optional errorMessage
    .successMessage(String) // optional successMessage
    .metadataDeleted(boolean) // required metadataDeleted
    .quiesced(boolean) // required quiesced
    .runType(com.iland.cohesity.iaas.backups.common.enums.RunType) // required runType
    .slaViolated(Boolean) // optional slaViolated
    .snapshotsDeleted(boolean) // required snapshotsDeleted
    .snapshotsDeletedTime(java.time.Instant) // optional snapshotsDeletedTime
    .addSourceBackupStatus|addAllSourceBackupStatus(com.iland.cohesity.iaas.backups.backupgroups.api.model.SourceBackupStatus) // sourceBackupStatus elements
    .stats(com.iland.cohesity.iaas.backups.backupgroups.api.model.BackupRunStats) // required stats
    .status(com.iland.cohesity.iaas.backups.backupgroups.enums.StatusBackupRun) // required status
    .addWarnings|addAllWarnings(String) // warnings elements
    .build();
 

Returns:

A new ImmutableBackupRun builder