ImmutableVMRestoreTaskParams (iland cloud Java SDK 1.0.45 API)

java.lang.Object
- com.iland.cohesity.iaas.backups.recovery.model.ImmutableVMRestoreTaskParams

All Implemented Interfaces:: VMRestoreTaskParams

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

Immutable implementation of VMRestoreTaskParams.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableVMRestoreTaskParams.Builder
Builds instances of type ImmutableVMRestoreTaskParams.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<AlternateVappParams>`	`alternateVapp()` Optionally specify an alternate vApp to recover snapshots to.
`static ImmutableVMRestoreTaskParams.Builder`	`builder()` Creates a builder for `ImmutableVMRestoreTaskParams`.
`boolean`	`continueOnError()` Whether the restoration should continue when an error occurs.
`static ImmutableVMRestoreTaskParams`	`copyOf(VMRestoreTaskParams instance)` Creates an immutable copy of a `VMRestoreTaskParams` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableVMRestoreTaskParams` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `snapshotRefs`, `taskName`, `alternateVapp`, `poweredOn`, `prefix`, `suffix`, `continueOnError`.
`boolean`	`poweredOn()` Specifies the power state of the cloned or recovered objects.
`String`	`prefix()` Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object.
`com.google.common.collect.ImmutableSet<VMSnapshotRef>`	`snapshotRefs()` The set of VM snapshots to restore.
`String`	`suffix()` Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object.
`String`	`taskName()` The user-specified name that should be associated with the task.
`String`	`toString()` Prints the immutable value `VMRestoreTaskParams` with attribute values.
`ImmutableVMRestoreTaskParams`	`withAlternateVapp(AlternateVappParams value)` Copy the current immutable object by setting a present value for the optional `alternateVapp` attribute.
`ImmutableVMRestoreTaskParams`	`withAlternateVapp(Optional<? extends AlternateVappParams> optional)` Copy the current immutable object by setting an optional value for the `alternateVapp` attribute.
`ImmutableVMRestoreTaskParams`	`withContinueOnError(boolean value)` Copy the current immutable object by setting a value for the `continueOnError` attribute.
`ImmutableVMRestoreTaskParams`	`withPoweredOn(boolean value)` Copy the current immutable object by setting a value for the `poweredOn` attribute.
`ImmutableVMRestoreTaskParams`	`withPrefix(String value)` Copy the current immutable object by setting a value for the `prefix` attribute.
`ImmutableVMRestoreTaskParams`	`withSnapshotRefs(Iterable<? extends VMSnapshotRef> elements)` Copy the current immutable object with elements that replace the content of `snapshotRefs`.
`ImmutableVMRestoreTaskParams`	`withSnapshotRefs(VMSnapshotRef... elements)` Copy the current immutable object with elements that replace the content of `snapshotRefs`.
`ImmutableVMRestoreTaskParams`	`withSuffix(String value)` Copy the current immutable object by setting a value for the `suffix` attribute.
`ImmutableVMRestoreTaskParams`	`withTaskName(String value)` Copy the current immutable object by setting a value for the `taskName` attribute.

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

- Method Detail
  - snapshotRefs
```
public com.google.common.collect.ImmutableSet<VMSnapshotRef> snapshotRefs()
```
    The set of VM snapshots to restore.
    
    Specified by:
    
    snapshotRefs in interface VMRestoreTaskParams
  - taskName
```
public String taskName()
```
    The user-specified name that should be associated with the task.
    
    Specified by:
    
    taskName in interface VMRestoreTaskParams
  - alternateVapp
```
public Optional<AlternateVappParams> alternateVapp()
```
    Optionally specify an alternate vApp to recover snapshots to.
    
    Specified by:
    
    alternateVapp in interface VMRestoreTaskParams
  - poweredOn
```
public boolean poweredOn()
```
    Specifies the power state of the cloned or recovered objects. By default, the cloned or recovered objects are powered off.
    
    Specified by:
    
    poweredOn in interface VMRestoreTaskParams
  - prefix
```
public String prefix()
```
    Specifies a prefix to prepended to the source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.
    
    Specified by:
    
    prefix in interface VMRestoreTaskParams
  - suffix
```
public String suffix()
```
    Specifies a suffix to appended to the original source object name to derive a new name for the recovered or cloned object. By default, cloned or recovered objects retain their original name. Length of this field is limited to 8 characters.
    
    Specified by:
    
    suffix in interface VMRestoreTaskParams
  - continueOnError
```
public boolean continueOnError()
```
    Whether the restoration should continue when an error occurs.
    
    Specified by:
    
    continueOnError in interface VMRestoreTaskParams
  - withSnapshotRefs
```
public final ImmutableVMRestoreTaskParams withSnapshotRefs(VMSnapshotRef... elements)
```
    Copy the current immutable object with elements that replace the content of snapshotRefs.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withSnapshotRefs
```
public final ImmutableVMRestoreTaskParams withSnapshotRefs(Iterable<? extends VMSnapshotRef> elements)
```
    Copy the current immutable object with elements that replace the content of snapshotRefs. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of snapshotRefs elements to set
    
    Returns:
    
    A modified copy of this object
  - withTaskName
```
public final ImmutableVMRestoreTaskParams 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
  - withAlternateVapp
```
public final ImmutableVMRestoreTaskParams withAlternateVapp(AlternateVappParams value)
```
    Copy the current immutable object by setting a present value for the optional alternateVapp attribute.
    
    Parameters:
    
    value - The value for alternateVapp
    
    Returns:
    
    A modified copy of this object
  - withAlternateVapp
```
public final ImmutableVMRestoreTaskParams withAlternateVapp(Optional<? extends AlternateVappParams> optional)
```
    Copy the current immutable object by setting an optional value for the alternateVapp 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 alternateVapp
    
    Returns:
    
    A modified copy of this object
  - withPoweredOn
```
public final ImmutableVMRestoreTaskParams withPoweredOn(boolean value)
```
    Copy the current immutable object by setting a value for the poweredOn attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for poweredOn
    
    Returns:
    
    A modified copy of the this object
  - withPrefix
```
public final ImmutableVMRestoreTaskParams withPrefix(String value)
```
    Copy the current immutable object by setting a value for the prefix attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for prefix
    
    Returns:
    
    A modified copy of the this object
  - withSuffix
```
public final ImmutableVMRestoreTaskParams withSuffix(String value)
```
    Copy the current immutable object by setting a value for the suffix attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for suffix
    
    Returns:
    
    A modified copy of the this object
  - withContinueOnError
```
public final ImmutableVMRestoreTaskParams withContinueOnError(boolean value)
```
    Copy the current immutable object by setting a value for the continueOnError attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for continueOnError
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableVMRestoreTaskParams 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: snapshotRefs, taskName, alternateVapp, poweredOn, prefix, suffix, continueOnError.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value VMRestoreTaskParams with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableVMRestoreTaskParams copyOf(VMRestoreTaskParams instance)
```
    Creates an immutable copy of a VMRestoreTaskParams 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 VMRestoreTaskParams instance
  - builder
```
public static ImmutableVMRestoreTaskParams.Builder builder()
```
    Creates a builder for ImmutableVMRestoreTaskParams.
```
 ImmutableVMRestoreTaskParams.builder()
    .addSnapshotRefs|addAllSnapshotRefs(com.iland.cohesity.iaas.backups.recovery.model.VMSnapshotRef) // snapshotRefs elements
    .taskName(String) // required taskName
    .alternateVapp(com.iland.cohesity.iaas.backups.recovery.model.AlternateVappParams) // optional alternateVapp
    .poweredOn(boolean) // required poweredOn
    .prefix(String) // required prefix
    .suffix(String) // required suffix
    .continueOnError(boolean) // required continueOnError
    .build();
 
```
    Returns:
    
    A new ImmutableVMRestoreTaskParams builder

Class ImmutableVMRestoreTaskParams

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

snapshotRefs

taskName

alternateVapp

poweredOn

prefix

suffix

continueOnError

withSnapshotRefs

withSnapshotRefs

withTaskName

withAlternateVapp

withAlternateVapp

withPoweredOn

withPrefix

withSuffix

withContinueOnError

equals

hashCode

toString

copyOf

builder