com.softlayer.api.service.virtual.Host

@ApiType("SoftLayer_Virtual_Host")
public class Host
extends Entity

The virtual host represents the platform on which virtual guests reside. At times a virtual host has no allocations on the physical server, however with many modern platforms it is a virtual machine with small CPU and Memory allocations that runs in the Control Domain.

See Also:: SoftLayer_Virtual_Host

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Host.Mask`
`static interface`	`Host.Service`	The virtual host service provides a common interface to any virtualization platform supported by SoftLayer.
`static interface`	`Host.ServiceAsync`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`	The account which a virtual host belongs to.
`protected Long`	`accountId`	A virtual host's associated account id
`protected boolean`	`accountIdSpecified`
`protected Boolean`	`billedPerGuestFlag`	Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate.
`protected Boolean`	`billedPerMemoryUsageFlag`	Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate.
`protected GregorianCalendar`	`createDate`	The date a virtual host was created.
`protected boolean`	`createDateSpecified`
`protected String`	`description`	A virtual host's description.
`protected boolean`	`descriptionSpecified`
`protected Long`	`enabledFlag`	The enabled flag specifies whether a virtual host can run guests.
`protected boolean`	`enabledFlagSpecified`
`protected Long`	`guestCount`	A count of the guests associated with a virtual host.
`protected List<Guest>`	`guests`	The guests associated with a virtual host.
`protected Server`	`hardware`	The hardware record which a virtual host resides on.
`protected Long`	`hardwareId`	A hardware device which a virtual host resides.
`protected boolean`	`hardwareIdSpecified`
`protected Long`	`id`	Unique ID for a virtual host.
`protected boolean`	`idSpecified`
`protected Object`	`metricTrackingObject`	The metric tracking object for this virtual host.
`protected GregorianCalendar`	`modifyDate`	The date a virtual host was last modified.
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	A virtual host's name.
`protected boolean`	`nameSpecified`
`protected Long`	`pciDeviceCount`	A count of
`protected List<PciDevice>`	`pciDevices`
`protected Long`	`physicalMemoryCapacity`	The amount of memory physically available for a virtual host.
`protected boolean`	`physicalMemoryCapacitySpecified`
`protected String`	`uuid`	Unique ID for a virtual host's record on a virtualization platform.
`protected boolean`	`uuidSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Host()

Method Summary

Modifier and Type	Method	Description
`Host.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`Boolean`	`getBilledPerGuestFlag()`
`Boolean`	`getBilledPerMemoryUsageFlag()`
`GregorianCalendar`	`getCreateDate()`
`String`	`getDescription()`
`Long`	`getEnabledFlag()`
`Long`	`getGuestCount()`
`List<Guest>`	`getGuests()`
`Server`	`getHardware()`
`Long`	`getHardwareId()`
`Long`	`getId()`
`Object`	`getMetricTrackingObject()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Long`	`getPciDeviceCount()`
`List<PciDevice>`	`getPciDevices()`
`Long`	`getPhysicalMemoryCapacity()`
`String`	`getUuid()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isDescriptionSpecified()`
`boolean`	`isEnabledFlagSpecified()`
`boolean`	`isHardwareIdSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isPhysicalMemoryCapacitySpecified()`
`boolean`	`isUuidSpecified()`
`static Host.Service`	`service(ApiClient client)`
`static Host.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setBilledPerGuestFlag(Boolean billedPerGuestFlag)`
`void`	`setBilledPerMemoryUsageFlag(Boolean billedPerMemoryUsageFlag)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDescription(String description)`
`void`	`setEnabledFlag(Long enabledFlag)`
`void`	`setGuestCount(Long guestCount)`
`void`	`setHardware(Server hardware)`
`void`	`setHardwareId(Long hardwareId)`
`void`	`setId(Long id)`
`void`	`setMetricTrackingObject(Object metricTrackingObject)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setPciDeviceCount(Long pciDeviceCount)`
`void`	`setPhysicalMemoryCapacity(Long physicalMemoryCapacity)`
`void`	`setUuid(String uuid)`
`void`	`unsetAccountId()`
`void`	`unsetCreateDate()`
`void`	`unsetDescription()`
`void`	`unsetEnabledFlag()`
`void`	`unsetHardwareId()`
`void`	`unsetId()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetPhysicalMemoryCapacity()`
`void`	`unsetUuid()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- account
  
  @ApiProperty protected Account account
  
  The account which a virtual host belongs to.
- billedPerGuestFlag
  
  @ApiProperty protected Boolean billedPerGuestFlag
  
  Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate.
- billedPerMemoryUsageFlag
  
  @ApiProperty protected Boolean billedPerMemoryUsageFlag
  
  Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate.
- guests
  
  @ApiProperty protected List<Guest> guests
  
  The guests associated with a virtual host.
- hardware
  
  @ApiProperty protected Server hardware
  
  The hardware record which a virtual host resides on.
- metricTrackingObject
  
  @ApiProperty protected Object metricTrackingObject
  
  The metric tracking object for this virtual host.
- pciDevices
  
  @ApiProperty protected List<PciDevice> pciDevices
- accountId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long accountId
  
  A virtual host's associated account id
- accountIdSpecified
  
  protected boolean accountIdSpecified
- createDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar createDate
  
  The date a virtual host was created.
- createDateSpecified
  
  protected boolean createDateSpecified
- description
  
  @ApiProperty(canBeNullOrNotSet=true) protected String description
  
  A virtual host's description.
- descriptionSpecified
  
  protected boolean descriptionSpecified
- enabledFlag
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long enabledFlag
  
  The enabled flag specifies whether a virtual host can run guests.
- enabledFlagSpecified
  
  protected boolean enabledFlagSpecified
- hardwareId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long hardwareId
  
  A hardware device which a virtual host resides.
- hardwareIdSpecified
  
  protected boolean hardwareIdSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  Unique ID for a virtual host.
- idSpecified
  
  protected boolean idSpecified
- modifyDate
  
  @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
  
  The date a virtual host was last modified.
- modifyDateSpecified
  
  protected boolean modifyDateSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  A virtual host's name.
- nameSpecified
  
  protected boolean nameSpecified
- physicalMemoryCapacity
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long physicalMemoryCapacity
  
  The amount of memory physically available for a virtual host.
- physicalMemoryCapacitySpecified
  
  protected boolean physicalMemoryCapacitySpecified
- uuid
  
  @ApiProperty(canBeNullOrNotSet=true) protected String uuid
  
  Unique ID for a virtual host's record on a virtualization platform.
- uuidSpecified
  
  protected boolean uuidSpecified
- guestCount
  
  @ApiProperty protected Long guestCount
  
  A count of the guests associated with a virtual host.
- pciDeviceCount
  
  @ApiProperty protected Long pciDeviceCount
  
  A count of
Constructor Details
- Host
  
  public Host()
Method Details
- getAccount
  
  public Account getAccount()
- setAccount
  
  public void setAccount(Account account)
- getBilledPerGuestFlag
  
  public Boolean getBilledPerGuestFlag()
- setBilledPerGuestFlag
  
  public void setBilledPerGuestFlag(Boolean billedPerGuestFlag)
- getBilledPerMemoryUsageFlag
  
  public Boolean getBilledPerMemoryUsageFlag()
- setBilledPerMemoryUsageFlag
  
  public void setBilledPerMemoryUsageFlag(Boolean billedPerMemoryUsageFlag)
- getGuests
  
  public List<Guest> getGuests()
- getHardware
  
  public Server getHardware()
- setHardware
  
  public void setHardware(Server hardware)
- getMetricTrackingObject
  
  public Object getMetricTrackingObject()
- setMetricTrackingObject
  
  public void setMetricTrackingObject(Object metricTrackingObject)
- getPciDevices
  
  public List<PciDevice> getPciDevices()
- getAccountId
  
  public Long getAccountId()
- setAccountId
  
  public void setAccountId(Long accountId)
- isAccountIdSpecified
  
  public boolean isAccountIdSpecified()
- unsetAccountId
  
  public void unsetAccountId()
- getCreateDate
  
  public GregorianCalendar getCreateDate()
- setCreateDate
  
  public void setCreateDate(GregorianCalendar createDate)
- isCreateDateSpecified
  
  public boolean isCreateDateSpecified()
- unsetCreateDate
  
  public void unsetCreateDate()
- getDescription
  
  public String getDescription()
- setDescription
  
  public void setDescription(String description)
- isDescriptionSpecified
  
  public boolean isDescriptionSpecified()
- unsetDescription
  
  public void unsetDescription()
- getEnabledFlag
  
  public Long getEnabledFlag()
- setEnabledFlag
  
  public void setEnabledFlag(Long enabledFlag)
- isEnabledFlagSpecified
  
  public boolean isEnabledFlagSpecified()
- unsetEnabledFlag
  
  public void unsetEnabledFlag()
- getHardwareId
  
  public Long getHardwareId()
- setHardwareId
  
  public void setHardwareId(Long hardwareId)
- isHardwareIdSpecified
  
  public boolean isHardwareIdSpecified()
- unsetHardwareId
  
  public void unsetHardwareId()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getModifyDate
  
  public GregorianCalendar getModifyDate()
- setModifyDate
  
  public void setModifyDate(GregorianCalendar modifyDate)
- isModifyDateSpecified
  
  public boolean isModifyDateSpecified()
- unsetModifyDate
  
  public void unsetModifyDate()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- getPhysicalMemoryCapacity
  
  public Long getPhysicalMemoryCapacity()
- setPhysicalMemoryCapacity
  
  public void setPhysicalMemoryCapacity(Long physicalMemoryCapacity)
- isPhysicalMemoryCapacitySpecified
  
  public boolean isPhysicalMemoryCapacitySpecified()
- unsetPhysicalMemoryCapacity
  
  public void unsetPhysicalMemoryCapacity()
- getUuid
  
  public String getUuid()
- setUuid
  
  public void setUuid(String uuid)
- isUuidSpecified
  
  public boolean isUuidSpecified()
- unsetUuid
  
  public void unsetUuid()
- getGuestCount
  
  public Long getGuestCount()
- setGuestCount
  
  public void setGuestCount(Long guestCount)
- getPciDeviceCount
  
  public Long getPciDeviceCount()
- setPciDeviceCount
  
  public void setPciDeviceCount(Long pciDeviceCount)
- asService
  
  public Host.Service asService(ApiClient client)
- service
  
  public static Host.Service service(ApiClient client)
- service
  
  public static Host.Service service(ApiClient client, Long id)

Class Host

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details