VirtualGuest (jclouds 1.4.1 API)

Nested Classes
Modifier and Type	Class and Description
`static class`	`VirtualGuest.Builder`
`static class`	`VirtualGuest.State` These states come from the powerState field.

Constructors
Constructor and Description
VirtualGuest(int accountId, Date createDate, boolean dedicatedAccountHostOnly, String domain, String fullyQualifiedDomainName, String hostname, int id, Date lastVerifiedDate, int maxCpu, String maxCpuUnits, int maxMemory, Date metricPollDate, Date modifyDate, String notes, boolean privateNetworkOnly, int startCpus, int statusId, String uuid, String primaryBackendIpAddress, String primaryIpAddress, int billingItemId, OperatingSystem operatingSystem, Datacenter datacenter, PowerState powerState)

Methods
Modifier and Type	Method and Description
`static VirtualGuest.Builder`	`builder()`
`int`	`compareTo(VirtualGuest arg0)`
`boolean`	`equals(Object obj)`
`int`	`getAccountId()`
`int`	`getBillingItemId()`
`Date`	`getCreateDate()`
`Datacenter`	`getDatacenter()`
`String`	`getDomain()`
`String`	`getFullyQualifiedDomainName()`
`String`	`getHostname()`
`int`	`getId()`
`Date`	`getLastVerifiedDate()`
`int`	`getMaxCpu()`
`String`	`getMaxCpuUnits()`
`int`	`getMaxMemory()`
`Date`	`getMetricPollDate()`
`Date`	`getModifyDate()`
`String`	`getNotes()`
`OperatingSystem`	`getOperatingSystem()`
`PowerState`	`getPowerState()`
`String`	`getPrimaryBackendIpAddress()`
`String`	`getPrimaryIpAddress()`
`int`	`getStartCpus()`
`int`	`getStatusId()`
`String`	`getUuid()`
`int`	`hashCode()`
`boolean`	`isDedicatedAccountHostOnly()`
`boolean`	`isPrivateNetworkOnly()`
`String`	`toString()`

java.lang.Object
- org.jclouds.softlayer.domain.VirtualGuest

All Implemented Interfaces:

Comparable<VirtualGuest>

Direct Known Subclasses:

SoftLayerParserModule.VirtualGuestAdapter.VirtualGuestInternal
```
public class VirtualGuest
extends Object
implements Comparable<VirtualGuest>
```
The virtual guest data type presents the structure in which all virtual guests will be presented. Internally, the structure supports various virtualization platforms with no change to external interaction.
A guest, also known as a virtual server or CloudLayer Computing Instance, represents an allocation of resources on a virtual host. The hostname and domain must be alphanumeric strings that may be separated by periods '.'. The only other allowable special character is the dash '-'. However the special characters '.' and '-' may not be consecutive. Each alphanumeric string separated by a period is considered a label. Labels must begin and end with an alphanumeric character. Each label cannot be soley comprised of digits and must be between 1-63 characters in length. The last label, the TLD (top level domain) must be between 2-6 alphabetic characters. The domain portion must consist of least one label followed by a period '.' then ending with the TLD label. Combining the hostname, followed by a period '.', followed by the domain gives the FQDN (fully qualified domain name), which may not exceed 253 characters in total length.

Author:

Adrian Cole

See Also:

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VirtualGuest.Builder

static class VirtualGuest.State
These states come from the powerState field.

Constructor Summary

Constructors
Constructor and Description

VirtualGuest(int accountId, Date createDate, boolean dedicatedAccountHostOnly, String domain, String fullyQualifiedDomainName, String hostname, int id, Date lastVerifiedDate, int maxCpu, String maxCpuUnits, int maxMemory, Date metricPollDate, Date modifyDate, String notes, boolean privateNetworkOnly, int startCpus, int statusId, String uuid, String primaryBackendIpAddress, String primaryIpAddress, int billingItemId, OperatingSystem operatingSystem, Datacenter datacenter, PowerState powerState)

Method Summary

Methods
Modifier and Type Method and Description

static VirtualGuest.Builder builder()

int compareTo(VirtualGuest arg0)

boolean equals(Object obj)

int getAccountId()

int getBillingItemId()

Date getCreateDate()

Datacenter getDatacenter()

String getDomain()

String getFullyQualifiedDomainName()

String getHostname()

int getId()

Date getLastVerifiedDate()

int getMaxCpu()

String getMaxCpuUnits()

int getMaxMemory()

Date getMetricPollDate()

Date getModifyDate()

String getNotes()

OperatingSystem getOperatingSystem()

PowerState getPowerState()

String getPrimaryBackendIpAddress()

String getPrimaryIpAddress()

int getStartCpus()

int getStatusId()

String getUuid()

int hashCode()

boolean isDedicatedAccountHostOnly()

boolean isPrivateNetworkOnly()

String toString()

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

- Constructor Detail
  - VirtualGuest
```
public VirtualGuest(int accountId,
            Date createDate,
            boolean dedicatedAccountHostOnly,
            String domain,
            String fullyQualifiedDomainName,
            String hostname,
            int id,
            Date lastVerifiedDate,
            int maxCpu,
            String maxCpuUnits,
            int maxMemory,
            Date metricPollDate,
            Date modifyDate,
            String notes,
            boolean privateNetworkOnly,
            int startCpus,
            int statusId,
            String uuid,
            String primaryBackendIpAddress,
            String primaryIpAddress,
            int billingItemId,
            OperatingSystem operatingSystem,
            Datacenter datacenter,
            PowerState powerState)
```
- Method Detail
  - builder
```
public static VirtualGuest.Builder builder()
```
  - compareTo
```
public int compareTo(VirtualGuest arg0)
```
    Specified by:
    
    compareTo in interface Comparable<VirtualGuest>
  - getAccountId
```
public int getAccountId()
```
    Returns:
    A computing instance's associated account id
  - getCreateDate
```
public Date getCreateDate()
```
    Returns:
    The date a virtual computing instance was created.
  - isDedicatedAccountHostOnly
```
public boolean isDedicatedAccountHostOnly()
```
    Returns:
    When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
  - getDomain
```
public String getDomain()
```
    Returns:
    A computing instance's domain name
  - getFullyQualifiedDomainName
```
public String getFullyQualifiedDomainName()
```
    Returns:
    A name reflecting the hostname and domain of the computing instance.
  - getHostname
```
public String getHostname()
```
    Returns:
    A virtual computing instance's hostname
  - getId
```
public int getId()
```
    Returns:
    Unique ID for a computing instance.
  - getLastVerifiedDate
```
public Date getLastVerifiedDate()
```
    Returns:
    The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform.
  - getMaxCpu
```
public int getMaxCpu()
```
    Returns:
    The maximum amount of CPU resources a computing instance may utilize.
  - getMaxCpuUnits
```
public String getMaxCpuUnits()
```
    Returns:
    The unit of the maximum amount of CPU resources a computing instance may utilize.
  - getMaxMemory
```
public int getMaxMemory()
```
    Returns:
    The maximum amount of memory a computing instance may utilize.
  - getMetricPollDate
```
public Date getMetricPollDate()
```
    Returns:
    The date of the most recent metric tracking poll performed.
  - getModifyDate
```
public Date getModifyDate()
```
    Returns:
    The date a virtual computing instance was last modified.
  - getNotes
```
public String getNotes()
```
    Returns:
    A small note about a cloud instance to use at your discretion.
  - isPrivateNetworkOnly
```
public boolean isPrivateNetworkOnly()
```
    Returns:
    Whether the computing instance only has access to the private network.
  - getStartCpus
```
public int getStartCpus()
```
    Returns:
    The number of CPUs available to a computing instance upon startup.
  - getStatusId
```
public int getStatusId()
```
    Returns:
    A computing instances status ID
  - getUuid
```
public String getUuid()
```
    Returns:
    Unique ID for a computing instance's record on a virtualization platform.
  - getPrimaryBackendIpAddress
```
public String getPrimaryBackendIpAddress()
```
    Returns:
    private ip address
  - getPrimaryIpAddress
```
public String getPrimaryIpAddress()
```
    Returns:
    public ip address
  - getBillingItemId
```
public int getBillingItemId()
```
    Returns:
    The billing item for a CloudLayer Compute Instance.
  - getOperatingSystem
```
public OperatingSystem getOperatingSystem()
```
    Returns:
    A guest's operating system.
  - getDatacenter
```
public Datacenter getDatacenter()
```
    Returns:
    The guest's datacenter
  - getPowerState
```
public PowerState getPowerState()
```
    Returns:
    The current power state of a virtual guest.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class VirtualGuest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualGuest

Method Detail

builder

compareTo

getAccountId

getCreateDate

isDedicatedAccountHostOnly

getDomain

getFullyQualifiedDomainName

getHostname

getId

getLastVerifiedDate

getMaxCpu

getMaxCpuUnits

getMaxMemory

getMetricPollDate

getModifyDate

getNotes

isPrivateNetworkOnly

getStartCpus

getStatusId

getUuid

getPrimaryBackendIpAddress

getPrimaryIpAddress

getBillingItemId

getOperatingSystem

getDatacenter

getPowerState

hashCode

equals

toString