java.lang.Object
- org.jclouds.cim.SettingData
- - org.jclouds.cim.ManagedElement
  - - org.jclouds.cim.VirtualSystemSettingData

All Implemented Interfaces:

Comparable<SettingData>
```
public class VirtualSystemSettingData
extends ManagedElement
```
CIM_VirtualSystemSettingData defines the virtual aspects of a virtual system through a set of virtualization specific properties. CIM_VirtualSystemSettingData is also used as the top level class of virtual system configurations. Virtual system configurations model configuration information about virtual systems and their components. A virtual system configuration consists of one top-level instance of class CIM_VirtualSystemSettingData that aggregates a number of instances of class CIM_ResourceAllocationSettingData, using association CIM_ConcreteComponent. Virtual system configurations may for example be used to reflect configurations of - virtual systems that are defined at a virtualization platform, - virtual systems that are currently active, - input requests to create new virtual systems, - input requests to modify existing virtual systems, or - snapshots of virtual systems.

See Also:

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VirtualSystemSettingData.AutomaticRecoveryAction
Action to take for the virtual system when the software executed by the virtual system fails.

static class VirtualSystemSettingData.AutomaticShutdownAction
Action to take for the virtual system when the host is shut down.

static class VirtualSystemSettingData.AutomaticStartupAction
Action to take for the virtual system when the host is started.

static class VirtualSystemSettingData.Builder

Field Summary

Fields inherited from class org.jclouds.cim.ManagedElement
caption, description

Fields inherited from class org.jclouds.cim.SettingData
elementName, instanceID

Constructor Summary

Constructors
Constructor Description

VirtualSystemSettingData(String elementName, String instanceID, String caption, String description, VirtualSystemSettingData.AutomaticRecoveryAction automaticRecoveryAction, VirtualSystemSettingData.AutomaticShutdownAction automaticShutdownAction, VirtualSystemSettingData.AutomaticStartupAction automaticStartupAction, Long automaticStartupActionDelay, Integer automaticStartupActionSequenceNumber, URI configurationDataRoot, URI configurationFile, String configurationID, Date creationTime, URI logDataRoot, URI recoveryFile, URI snapshotDataRoot, URI suspendDataRoot, URI swapFileDataRoot, String virtualSystemIdentifier, Iterable<String> virtualSystemTypes, String notes)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type Method Description

static VirtualSystemSettingData.Builder builder()

boolean equals(Object obj)

VirtualSystemSettingData.AutomaticRecoveryAction getAutomaticRecoveryAction()
Action to take for the virtual system when the software executed by the virtual system fails.

VirtualSystemSettingData.AutomaticShutdownAction getAutomaticShutdownAction()
Action to take for the virtual system when the host is shut down.

VirtualSystemSettingData.AutomaticStartupAction getAutomaticStartupAction()
Action to take for the virtual system when the host is started.

Long getAutomaticStartupActionDelay()
Delay applicable to startup action.

Integer getAutomaticStartupActionSequenceNumber()
Number indicating the relative sequence of virtual system activation when the host system is started.

URI getConfigurationDataRoot()
Filepath of a directory where information about the virtual system configuration is stored.Format shall be URI based on RFC 2079.

URI getConfigurationFile()
Filepath of a file where information about the virtual system configuration is stored.

String getConfigurationID()
Unique id of the virtual system configuration.

Date getCreationTime()
Time when the virtual system configuration was created.

URI getLogDataRoot()
Filepath of a directory where log information about the virtual system is stored.

String getNotes()
End-user supplied notes that are related to the virtual system.

URI getRecoveryFile()
Filepath of a file where recovery related information of the virtual system is stored.Format shall be URI based on RFC 2079.

URI getSnapshotDataRoot()
Filepath of a directory where information about virtual system snapshots is stored.

URI getSuspendDataRoot()
Filepath of a directory where suspend related information about the virtual system is stored.

URI getSwapFileDataRoot()
Filepath of a directory where swapfiles of the virtual system are stored.

String getVirtualSystemIdentifier()
VirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform.

Set<String> getVirtualSystemTypes()
VirtualSystemType shall reflect a particular type of virtual system.

int hashCode()

VirtualSystemSettingData.Builder toBuilder()

String toString()

Methods inherited from class org.jclouds.cim.ManagedElement
getCaption, getDescription

Methods inherited from class org.jclouds.cim.SettingData
compareTo, getElementName, getInstanceID

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

- Constructor Detail
  - VirtualSystemSettingData
```
public VirtualSystemSettingData(String elementName,
                                String instanceID,
                                String caption,
                                String description,
                                VirtualSystemSettingData.AutomaticRecoveryAction automaticRecoveryAction,
                                VirtualSystemSettingData.AutomaticShutdownAction automaticShutdownAction,
                                VirtualSystemSettingData.AutomaticStartupAction automaticStartupAction,
                                Long automaticStartupActionDelay,
                                Integer automaticStartupActionSequenceNumber,
                                URI configurationDataRoot,
                                URI configurationFile,
                                String configurationID,
                                Date creationTime,
                                URI logDataRoot,
                                URI recoveryFile,
                                URI snapshotDataRoot,
                                URI suspendDataRoot,
                                URI swapFileDataRoot,
                                String virtualSystemIdentifier,
                                Iterable<String> virtualSystemTypes,
                                String notes)
```
- Method Detail
  - builder
```
public static VirtualSystemSettingData.Builder builder()
```
  - toBuilder
```
public VirtualSystemSettingData.Builder toBuilder()
```
    Overrides:
    
    toBuilder in class ManagedElement
  - getAutomaticRecoveryAction
```
public VirtualSystemSettingData.AutomaticRecoveryAction getAutomaticRecoveryAction()
```
    Action to take for the virtual system when the software executed by the virtual system fails. Failures in this case means a failure that is detectable by the host platform, such as a non-interruptible wait state condition.
  - getAutomaticShutdownAction
```
public VirtualSystemSettingData.AutomaticShutdownAction getAutomaticShutdownAction()
```
    Action to take for the virtual system when the host is shut down.
  - getAutomaticStartupAction
```
public VirtualSystemSettingData.AutomaticStartupAction getAutomaticStartupAction()
```
    Action to take for the virtual system when the host is started.
  - getAutomaticStartupActionDelay
```
public Long getAutomaticStartupActionDelay()
```
    Delay applicable to startup action. The value shall be in the interval variant of the datetime datatype.
  - getAutomaticStartupActionSequenceNumber
```
public Integer getAutomaticStartupActionSequenceNumber()
```
    Number indicating the relative sequence of virtual system activation when the host system is started. A lower number indicates earlier activation. If one or more configurations show the same value, the sequence is implementation dependent. A value of 0 indicates that the sequence is implementation dependent.
  - getConfigurationDataRoot
```
public URI getConfigurationDataRoot()
```
    Filepath of a directory where information about the virtual system configuration is stored.Format shall be URI based on RFC 2079.
  - getConfigurationFile
```
public URI getConfigurationFile()
```
    Filepath of a file where information about the virtual system configuration is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.
  - getConfigurationID
```
public String getConfigurationID()
```
    Unique id of the virtual system configuration. Note that the ConfigurationID is different from the InstanceID as it is assigned by the implementation to a virtual system or a virtual system configuration. It is not a key, and the same value may occur within more than one instance.
  - getCreationTime
```
public Date getCreationTime()
```
    Time when the virtual system configuration was created.
  - getLogDataRoot
```
public URI getLogDataRoot()
```
    Filepath of a directory where log information about the virtual system is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.
  - getRecoveryFile
```
public URI getRecoveryFile()
```
    Filepath of a file where recovery related information of the virtual system is stored.Format shall be URI based on RFC 2079.
  - getSnapshotDataRoot
```
public URI getSnapshotDataRoot()
```
    Filepath of a directory where information about virtual system snapshots is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.
  - getSuspendDataRoot
```
public URI getSuspendDataRoot()
```
    Filepath of a directory where suspend related information about the virtual system is stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.
  - getSwapFileDataRoot
```
public URI getSwapFileDataRoot()
```
    Filepath of a directory where swapfiles of the virtual system are stored. A relative path appends to the value of the ConfigurationDataRoot property.Format shall be URI based on RFC 2079.
  - getVirtualSystemIdentifier
```
public String getVirtualSystemIdentifier()
```
    VirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform. Note that the VirtualSystemIdentifier is not the hostname assigned to the operating system instance running within the virtual system, nor is it an IP address or MAC address assigned to any of its network ports. On create requests VirtualSystemIdentifier may contain implementation specific rules (like simple patterns or regular expression) that may be interpreted by the implementation when assigning a VirtualSystemIdentifier.
  - getVirtualSystemTypes
```
public Set<String> getVirtualSystemTypes()
```
    VirtualSystemType shall reflect a particular type of virtual system.
  - getNotes
```
public String getNotes()
```
    End-user supplied notes that are related to the virtual system.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SettingData
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class SettingData
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ManagedElement

Modifier and Type	Class	Description
`static class`	`VirtualSystemSettingData.AutomaticRecoveryAction`	Action to take for the virtual system when the software executed by the virtual system fails.
`static class`	`VirtualSystemSettingData.AutomaticShutdownAction`	Action to take for the virtual system when the host is shut down.
`static class`	`VirtualSystemSettingData.AutomaticStartupAction`	Action to take for the virtual system when the host is started.
`static class`	`VirtualSystemSettingData.Builder`

Modifier and Type	Method	Description
`static VirtualSystemSettingData.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`VirtualSystemSettingData.AutomaticRecoveryAction`	`getAutomaticRecoveryAction()`	Action to take for the virtual system when the software executed by the virtual system fails.
`VirtualSystemSettingData.AutomaticShutdownAction`	`getAutomaticShutdownAction()`	Action to take for the virtual system when the host is shut down.
`VirtualSystemSettingData.AutomaticStartupAction`	`getAutomaticStartupAction()`	Action to take for the virtual system when the host is started.
`Long`	`getAutomaticStartupActionDelay()`	Delay applicable to startup action.
`Integer`	`getAutomaticStartupActionSequenceNumber()`	Number indicating the relative sequence of virtual system activation when the host system is started.
`URI`	`getConfigurationDataRoot()`	Filepath of a directory where information about the virtual system configuration is stored.Format shall be URI based on RFC 2079.
`URI`	`getConfigurationFile()`	Filepath of a file where information about the virtual system configuration is stored.
`String`	`getConfigurationID()`	Unique id of the virtual system configuration.
`Date`	`getCreationTime()`	Time when the virtual system configuration was created.
`URI`	`getLogDataRoot()`	Filepath of a directory where log information about the virtual system is stored.
`String`	`getNotes()`	End-user supplied notes that are related to the virtual system.
`URI`	`getRecoveryFile()`	Filepath of a file where recovery related information of the virtual system is stored.Format shall be URI based on RFC 2079.
`URI`	`getSnapshotDataRoot()`	Filepath of a directory where information about virtual system snapshots is stored.
`URI`	`getSuspendDataRoot()`	Filepath of a directory where suspend related information about the virtual system is stored.
`URI`	`getSwapFileDataRoot()`	Filepath of a directory where swapfiles of the virtual system are stored.
`String`	`getVirtualSystemIdentifier()`	VirtualSystemIdentifier shall reflect a unique name for the system as it is used within the virtualization platform.
`Set<String>`	`getVirtualSystemTypes()`	VirtualSystemType shall reflect a particular type of virtual system.
`int`	`hashCode()`
`VirtualSystemSettingData.Builder`	`toBuilder()`
`String`	`toString()`

Class VirtualSystemSettingData

Nested Class Summary

Field Summary

Fields inherited from class org.jclouds.cim.ManagedElement

Fields inherited from class org.jclouds.cim.SettingData

Constructor Summary

Method Summary

Methods inherited from class org.jclouds.cim.ManagedElement

Methods inherited from class org.jclouds.cim.SettingData

Methods inherited from class java.lang.Object

Constructor Detail

VirtualSystemSettingData

Method Detail

builder

toBuilder

getAutomaticRecoveryAction

getAutomaticShutdownAction

getAutomaticStartupAction

getAutomaticStartupActionDelay

getAutomaticStartupActionSequenceNumber

getConfigurationDataRoot

getConfigurationFile

getConfigurationID

getCreationTime

getLogDataRoot

getRecoveryFile

getSnapshotDataRoot

getSuspendDataRoot

getSwapFileDataRoot

getVirtualSystemIdentifier

getVirtualSystemTypes

getNotes

hashCode

equals

toString