com.iland.cohesity.iaas.backups.common.model

Class ImmutableRestoreTask

java.lang.Object

com.iland.cohesity.iaas.backups.common.model.ImmutableRestoreTask

All Implemented Interfaces:

RestoreTask

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

Immutable implementation of RestoreTask.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
BackupGroupUid	backupGroupUid() The UID of the backup group.
static ImmutableRestoreTask.Builder	builder() Creates a builder for ImmutableRestoreTask.
CompanyId	companyId() The ID of the associated company.
static ImmutableRestoreTask	copyOf(RestoreTask instance) Creates an immutable copy of a RestoreTask value.
Optional<Instant>	endTime() The end time of the task.
boolean	equals(Object another) This instance is equal to all instances of ImmutableRestoreTask that have equal attribute values.
Optional<String>	errorMessage() Error message associated with task, if applicable.
int	hashCode() Computes a hash code from attributes: taskName, locationId, companyId, orgUuid, vdcUuid, uid, backupGroupUid, startTime, endTime, type, status, vmRecoveryOptions, errorMessage, objects, objectStates.
LocationId	locationId() The ID of the associated location.
com.google.common.collect.ImmutableSet<RestoreTaskObject>	objects() The objects that are being restored from.
com.google.common.collect.ImmutableSet<RestoreTaskObjectState>	objectStates() The states of the restore task objects.
OrgUuid	orgUuid() The UUID of the associated Org.
Instant	startTime() The start time of the task.
RestoreTaskStatus	status() The status of the task.
String	taskName() The user-specified restore task name.
String	toString() Prints the immutable value RestoreTask with attribute values.
RestoreTaskType	type() The type of the task.
RestoreTaskUid	uid() The UID of the task.
VdcUuid	vdcUuid() The UUID of the associated vDC.
Optional<VMRecoveryOptions>	vmRecoveryOptions() The VM recovery options that were selected for the restore.
ImmutableRestoreTask	withBackupGroupUid(BackupGroupUid value) Copy the current immutable object by setting a value for the backupGroupUid attribute.
ImmutableRestoreTask	withCompanyId(CompanyId value) Copy the current immutable object by setting a value for the companyId attribute.
ImmutableRestoreTask	withEndTime(Instant value) Copy the current immutable object by setting a present value for the optional endTime attribute.
ImmutableRestoreTask	withEndTime(Optional<? extends Instant> optional) Copy the current immutable object by setting an optional value for the endTime attribute.
ImmutableRestoreTask	withErrorMessage(Optional<String> optional) Copy the current immutable object by setting an optional value for the errorMessage attribute.
ImmutableRestoreTask	withErrorMessage(String value) Copy the current immutable object by setting a present value for the optional errorMessage attribute.
ImmutableRestoreTask	withLocationId(LocationId value) Copy the current immutable object by setting a value for the locationId attribute.
ImmutableRestoreTask	withObjects(Iterable<? extends RestoreTaskObject> elements) Copy the current immutable object with elements that replace the content of objects.
ImmutableRestoreTask	withObjects(RestoreTaskObject... elements) Copy the current immutable object with elements that replace the content of objects.
ImmutableRestoreTask	withObjectStates(Iterable<? extends RestoreTaskObjectState> elements) Copy the current immutable object with elements that replace the content of objectStates.
ImmutableRestoreTask	withObjectStates(RestoreTaskObjectState... elements) Copy the current immutable object with elements that replace the content of objectStates.
ImmutableRestoreTask	withOrgUuid(OrgUuid value) Copy the current immutable object by setting a value for the orgUuid attribute.
ImmutableRestoreTask	withStartTime(Instant value) Copy the current immutable object by setting a value for the startTime attribute.
ImmutableRestoreTask	withStatus(RestoreTaskStatus value) Copy the current immutable object by setting a value for the status attribute.
ImmutableRestoreTask	withTaskName(String value) Copy the current immutable object by setting a value for the taskName attribute.
ImmutableRestoreTask	withType(RestoreTaskType value) Copy the current immutable object by setting a value for the type attribute.
ImmutableRestoreTask	withUid(RestoreTaskUid value) Copy the current immutable object by setting a value for the uid attribute.
ImmutableRestoreTask	withVdcUuid(VdcUuid value) Copy the current immutable object by setting a value for the vdcUuid attribute.
ImmutableRestoreTask	withVmRecoveryOptions(Optional<? extends VMRecoveryOptions> optional) Copy the current immutable object by setting an optional value for the vmRecoveryOptions attribute.
ImmutableRestoreTask	withVmRecoveryOptions(VMRecoveryOptions value) Copy the current immutable object by setting a present value for the optional vmRecoveryOptions attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

taskName

public String taskName()

The user-specified restore task name.

Specified by:

taskName in interface RestoreTask

locationId

public LocationId locationId()

The ID of the associated location.

Specified by:

locationId in interface RestoreTask

companyId

public CompanyId companyId()

The ID of the associated company.

Specified by:

companyId in interface RestoreTask

orgUuid

public OrgUuid orgUuid()

The UUID of the associated Org.

Specified by:

orgUuid in interface RestoreTask

vdcUuid

public VdcUuid vdcUuid()

The UUID of the associated vDC.

Specified by:

vdcUuid in interface RestoreTask

uid

public RestoreTaskUid uid()

The UID of the task.

Specified by:

uid in interface RestoreTask

backupGroupUid

public BackupGroupUid backupGroupUid()

The UID of the backup group.

Specified by:

backupGroupUid in interface RestoreTask

startTime

public Instant startTime()

The start time of the task.

Specified by:

startTime in interface RestoreTask

endTime

public Optional<Instant> endTime()

The end time of the task.

Specified by:

endTime in interface RestoreTask

type

public RestoreTaskType type()

The type of the task.

Specified by:

type in interface RestoreTask

status

public RestoreTaskStatus status()

The status of the task.

Specified by:

status in interface RestoreTask

vmRecoveryOptions

public Optional<VMRecoveryOptions> vmRecoveryOptions()

The VM recovery options that were selected for the restore. Only applicable if the type of task is RestoreTaskType.RESTORE_VMS.

Specified by:

vmRecoveryOptions in interface RestoreTask

errorMessage

public Optional<String> errorMessage()

Error message associated with task, if applicable.

Specified by:

errorMessage in interface RestoreTask

objects

public com.google.common.collect.ImmutableSet<RestoreTaskObject> objects()

The objects that are being restored from.

Specified by:

objects in interface RestoreTask

objectStates

public com.google.common.collect.ImmutableSet<RestoreTaskObjectState> objectStates()

The states of the restore task objects.

Specified by:

objectStates in interface RestoreTask

withTaskName

public final ImmutableRestoreTask withTaskName(String value)

Copy the current immutable object by setting a value for the taskName attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for taskName

Returns:

A modified copy of the this object

withLocationId

public final ImmutableRestoreTask withLocationId(LocationId value)

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

Parameters:

value - A new value for locationId

Returns:

A modified copy of the this object

withCompanyId

public final ImmutableRestoreTask withCompanyId(CompanyId value)

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

Parameters:

value - A new value for companyId

Returns:

A modified copy of the this object

withOrgUuid

public final ImmutableRestoreTask withOrgUuid(OrgUuid value)

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

Parameters:

value - A new value for orgUuid

Returns:

A modified copy of the this object

withVdcUuid

public final ImmutableRestoreTask withVdcUuid(VdcUuid value)

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

Parameters:

value - A new value for vdcUuid

Returns:

A modified copy of the this object

withUid

public final ImmutableRestoreTask withUid(RestoreTaskUid value)

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

Parameters:

value - A new value for uid

Returns:

A modified copy of the this object

withBackupGroupUid

public final ImmutableRestoreTask withBackupGroupUid(BackupGroupUid value)

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

Parameters:

value - A new value for backupGroupUid

Returns:

A modified copy of the this object

withStartTime

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

withEndTime

public final ImmutableRestoreTask withEndTime(Instant value)

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

Parameters:

value - The value for endTime

Returns:

A modified copy of this object

withEndTime

public final ImmutableRestoreTask withEndTime(Optional<? extends Instant> optional)

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

Returns:

A modified copy of this object

withType

public final ImmutableRestoreTask withType(RestoreTaskType value)

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

Parameters:

value - A new value for type

Returns:

A modified copy of the this object

withStatus

public final ImmutableRestoreTask withStatus(RestoreTaskStatus 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

withVmRecoveryOptions

public final ImmutableRestoreTask withVmRecoveryOptions(VMRecoveryOptions value)

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

Parameters:

value - The value for vmRecoveryOptions

Returns:

A modified copy of this object

withVmRecoveryOptions

public final ImmutableRestoreTask withVmRecoveryOptions(Optional<? extends VMRecoveryOptions> optional)

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

Returns:

A modified copy of this object

withErrorMessage

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

withObjects

public final ImmutableRestoreTask withObjects(RestoreTaskObject... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withObjects

public final ImmutableRestoreTask withObjects(Iterable<? extends RestoreTaskObject> elements)

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

Parameters:

elements - An iterable of objects elements to set

Returns:

A modified copy of this object

withObjectStates

public final ImmutableRestoreTask withObjectStates(RestoreTaskObjectState... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withObjectStates

public final ImmutableRestoreTask withObjectStates(Iterable<? extends RestoreTaskObjectState> elements)

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

Parameters:

elements - An iterable of objectStates 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 ImmutableRestoreTask 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: taskName, locationId, companyId, orgUuid, vdcUuid, uid, backupGroupUid, startTime, endTime, type, status, vmRecoveryOptions, errorMessage, objects, objectStates.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value RestoreTask with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableRestoreTask copyOf(RestoreTask instance)

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

builder

public static ImmutableRestoreTask.Builder builder()

Creates a builder for ImmutableRestoreTask.

 ImmutableRestoreTask.builder()
    .taskName(String) // required taskName
    .locationId(com.iland.cohesity.iaas.backups.common.model.LocationId) // required locationId
    .companyId(com.iland.cohesity.iaas.backups.common.model.CompanyId) // required companyId
    .orgUuid(com.iland.cohesity.iaas.backups.common.model.OrgUuid) // required orgUuid
    .vdcUuid(com.iland.cohesity.iaas.backups.common.model.VdcUuid) // required vdcUuid
    .uid(com.iland.cohesity.iaas.backups.common.model.RestoreTaskUid) // required uid
    .backupGroupUid(com.iland.cohesity.iaas.backups.common.model.BackupGroupUid) // required backupGroupUid
    .startTime(java.time.Instant) // required startTime
    .endTime(java.time.Instant) // optional endTime
    .type(com.iland.cohesity.iaas.backups.common.enums.RestoreTaskType) // required type
    .status(com.iland.cohesity.iaas.backups.common.enums.RestoreTaskStatus) // required status
    .vmRecoveryOptions(com.iland.cohesity.iaas.backups.common.model.VMRecoveryOptions) // optional vmRecoveryOptions
    .errorMessage(String) // optional errorMessage
    .addObjects|addAllObjects(com.iland.cohesity.iaas.backups.common.model.RestoreTaskObject) // objects elements
    .addObjectStates|addAllObjectStates(com.iland.cohesity.iaas.backups.common.model.RestoreTaskObjectState) // objectStates elements
    .build();
 

Returns:

A new ImmutableRestoreTask builder