Package org.jclouds.softlayer.domain

Class VirtualGuest

java.lang.Object
org.jclouds.softlayer.domain.VirtualGuest
public class VirtualGuest extends Object
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 solely 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.
See Also:

  • Constructor Details

  • Method Details

    • builder

      public static VirtualGuest.Builder<?> builder()

    • toBuilder

      public VirtualGuest.Builder<?> toBuilder()

    • getAccountId

      public int getAccountId()
      Returns:
      A computing instance's associated account id

    • getCreateDate

      @Nullable public Date getCreateDate()
      Returns:
      The date a virtual computing instance was created.

    • getDomain

      @Nullable public String getDomain()
      Returns:
      A computing instance's domain name

    • getFullyQualifiedDomainName

      @Nullable public String getFullyQualifiedDomainName()
      Returns:
      A name reflecting the hostname and domain of the computing instance.

    • getHostname

      @Nullable public String getHostname()
      Returns:
      A virtual computing instance's hostname

    • getId

      public int getId()
      Returns:
      Unique ID for a computing instance.

    • getLastVerifiedDate

      @Nullable 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

      @Nullable 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

      @Nullable public Date getMetricPollDate()
      Returns:
      The date of the most recent metric tracking poll performed.

    • getModifyDate

      @Nullable public Date getModifyDate()
      Returns:
      The date a virtual computing instance was last modified.

    • getNotes

      @Nullable public String getNotes()
      Returns:
      A small note about a cloud instance to use at your discretion.

    • 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

      @Nullable public String getUuid()
      Returns:
      Unique ID for a computing instance's record on a virtualization platform.

    • getPrimaryBackendIpAddress

      @Nullable public String getPrimaryBackendIpAddress()
      Returns:
      private ip address

    • getPrimaryIpAddress

      @Nullable public String getPrimaryIpAddress()
      Returns:
      public ip address

    • getBillingItemId

      public int getBillingItemId()
      Returns:
      The billing item for a CloudLayer Compute Instance.

    • getOperatingSystem

      @Nullable public OperatingSystem getOperatingSystem()
      Returns:
      A guest's operating system.

    • getOperatingSystemReferenceCode

      public String getOperatingSystemReferenceCode()

    • getDatacenter

      @Nullable public Datacenter getDatacenter()
      Returns:
      The guest's datacenter

    • getSoftwareLicense

      @Nullable public SoftwareLicense getSoftwareLicense()
      Returns:
      The softwareLicense of a virtual guest.

    • getPowerState

      @Nullable public PowerState getPowerState()
      Returns:
      The current power state of a virtual guest.

    • getActiveTransactionCount

      public int getActiveTransactionCount()

    • getVirtualGuestBlockDevices

      @Nullable public List<VirtualGuestBlockDevice> getVirtualGuestBlockDevices()

    • isHourlyBillingFlag

      public boolean isHourlyBillingFlag()

    • isLocalDiskFlag

      public boolean isLocalDiskFlag()

    • isPrivateNetworkOnly

      public boolean isPrivateNetworkOnly()
      Returns:
      Whether the computing instance only has access to the private network.

    • 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.

    • getVirtualGuestBlockDeviceTemplateGroup

      public VirtualGuestBlockDeviceTemplateGroup getVirtualGuestBlockDeviceTemplateGroup()

    • getVirtualGuestNetworkComponents

      @Nullable public Set<VirtualGuestNetworkComponent> getVirtualGuestNetworkComponents()

    • getTagReferences

      @Nullable public Set<TagReference> getTagReferences()

    • getPrimaryNetworkComponent

      public VirtualGuestNetworkComponent getPrimaryNetworkComponent()

    • getPrimaryBackendNetworkComponent

      public VirtualGuestNetworkComponent getPrimaryBackendNetworkComponent()

    • getPostInstallScriptUri

      public String getPostInstallScriptUri()

    • getVirtualGuestAttribute

      public VirtualGuestAttribute getVirtualGuestAttribute()

    • getSshKeys

      public Set<SecuritySshKey> getSshKeys()

    • 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