Class Guest
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.virtual.Guest
@ApiType("SoftLayer_Virtual_Guest") public class Guest extends Entity
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, represents an allocation of resources on a virtual host.
A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
- See Also:
- SoftLayer_Virtual_Guest
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Guest.Mask
static interface
Guest.Service
The virtual guest service provides a common interface to any virtualization platform supported by SoftLayer.static interface
Guest.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Account
account
The account that a virtual guest belongs to.protected Long
accountId
A computing instance's associated [[SoftLayer_Account|account]] idprotected boolean
accountIdSpecified
protected Boolean
accountOwnedPoolFlag
protected List<Incident>
activeNetworkMonitorIncident
A virtual guest's currently active network monitoring incidents.protected Long
activeNetworkMonitorIncidentCount
A count of a virtual guest's currently active network monitoring incidents.protected Long
activeTicketCount
A count ofprotected List<Ticket>
activeTickets
protected Transaction
activeTransaction
A transaction that is still be performed on a cloud server.protected Long
activeTransactionCount
A count of any active transaction(s) that are currently running for the server (example: os reload).protected List<Transaction>
activeTransactions
Any active transaction(s) that are currently running for the server (example: os reload).protected Host
allowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.protected List<Storage>
allowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.protected Long
allowedNetworkStorageCount
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.protected Long
allowedNetworkStorageReplicaCount
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.protected List<Storage>
allowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.protected Component
antivirusSpywareSoftwareComponent
A antivirus / spyware software component object.protected Controller
applicationDeliveryController
protected Long
attributeCount
A count ofprotected List<Attribute>
attributes
protected List<Stratum>
availableMonitoring
An object that stores the maximum level for the monitoring query types and response types.protected Long
availableMonitoringCount
A count of an object that stores the maximum level for the monitoring query types and response types.protected BigDecimal
averageDailyPrivateBandwidthUsage
The average daily private bandwidth usage for the current billing cycle.protected BigDecimal
averageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.protected Long
backendNetworkComponentCount
A count of a guests's backend network components.protected List<Component>
backendNetworkComponents
A guests's backend network components.protected Long
backendRouterCount
A count of a guest's backend or private router.protected List<Hardware>
backendRouters
A guest's backend or private router.protected BigDecimal
bandwidthAllocation
A computing instance's allotted bandwidth (measured in GB).protected Detail
bandwidthAllotmentDetail
A computing instance's allotted detail record.protected List<Usage>
billingCycleBandwidthUsage
The raw bandwidth usage data for the current billing cycle.protected Long
billingCycleBandwidthUsageCount
A count of the raw bandwidth usage data for the current billing cycle.protected Usage
billingCyclePrivateBandwidthUsage
The raw private bandwidth usage data for the current billing cycle.protected Usage
billingCyclePublicBandwidthUsage
The raw public bandwidth usage data for the current billing cycle.protected Guest
billingItem
The billing item for a CloudLayer Compute Instance.protected Boolean
blockCancelBecauseDisconnectedFlag
Determines whether the instance is ineligible for cancellation because it is disconnected.protected Long
blockDeviceCount
A count of a computing instance's block devices.protected List<Device>
blockDevices
A computing instance's block devices.protected Group
blockDeviceTemplateGroup
The global identifier for the image template that was used to provision or reload a guest.protected Boolean
consoleIpAddressFlag
A flag indicating a computing instance's console IP address is assigned.protected IpAddress
consoleIpAddressRecord
A record containing information about a computing instance's console IP and port number.protected Component
continuousDataProtectionSoftwareComponent
A continuous data protection software component object.protected Component
controlPanel
A guest's control panel.protected GregorianCalendar
createDate
The date a virtual computing instance was created.protected boolean
createDateSpecified
protected Summary
currentBandwidthSummary
An object that provides commonly used bandwidth summary components for the current billing cycle.protected Location
datacenter
The datacenter that a virtual guest resides in.protected Boolean
dedicatedAccountHostOnlyFlag
When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.protected boolean
dedicatedAccountHostOnlyFlagSpecified
protected DedicatedHost
dedicatedHost
The dedicated host associated with this guest.protected String
domain
A computing instance's domain nameprotected boolean
domainSpecified
protected List<Storage>
evaultNetworkStorage
A guest's associated EVault network storage service account.protected Long
evaultNetworkStorageCount
A count of a guest's associated EVault network storage service account.protected Firewall
firewallServiceComponent
A computing instance's hardware firewall services.protected Long
frontendNetworkComponentCount
A count of a guest's frontend network components.protected List<Component>
frontendNetworkComponents
A guest's frontend network components.protected Hardware
frontendRouters
A guest's frontend or public router.protected String
fullyQualifiedDomainName
A name reflecting the hostname and domain of the computing instance.protected boolean
fullyQualifiedDomainNameSpecified
protected String
globalIdentifier
A guest's universally unique identifier.protected Long
gpuCount
The number of GPUs attached to the guest.protected String
gpuType
The name of the GPU type attached to the guest.protected Parameter
guestBootParameter
protected Host
host
The virtual host on which a virtual guest resides (available only on private clouds).protected Component
hostIpsSoftwareComponent
A host IPS software component object.protected String
hostname
A virtual computing instance's hostnameprotected boolean
hostnameSpecified
protected Boolean
hourlyBillingFlag
A guest's hourly billing status.protected Long
id
Unique ID for a computing instance.protected boolean
idSpecified
protected BigDecimal
inboundPrivateBandwidthUsage
The total private inbound bandwidth for this computing instance for the current billing cycle.protected BigDecimal
inboundPublicBandwidthUsage
The total public inbound bandwidth for this computing instance for the current billing cycle.protected Long
internalTagReferenceCount
A count ofprotected List<Reference>
internalTagReferences
protected State
lastKnownPowerState
The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.protected Transaction
lastOperatingSystemReload
The last transaction that a cloud server's operating system was loaded.protected Long
lastPowerStateId
protected boolean
lastPowerStateIdSpecified
protected Transaction
lastTransaction
The last transaction a cloud server had performed.protected GregorianCalendar
lastVerifiedDate
The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform.protected boolean
lastVerifiedDateSpecified
protected Incident
latestNetworkMonitorIncident
A virtual guest's latest network monitoring incident.protected Boolean
localDiskFlag
A flag indicating that the virtual guest has at least one disk which is local to the host it runs on.protected Location
location
Where guest is located within SoftLayer's location hierarchy.protected Boolean
managedResourceFlag
A flag indicating that the virtual guest is a managed resource.protected Long
maxCpu
The maximum amount of CPU resources a computing instance may utilize.protected boolean
maxCpuSpecified
protected String
maxCpuUnits
The unit of the maximum amount of CPU resources a computing instance may utilize.protected boolean
maxCpuUnitsSpecified
protected Long
maxMemory
The maximum amount of memory a computing instance may utilize.protected boolean
maxMemorySpecified
protected GregorianCalendar
metricPollDate
The date of the most recent metric tracking poll performed.protected boolean
metricPollDateSpecified
protected Object
metricTrackingObject
A guest's metric tracking object.protected Long
metricTrackingObjectId
The metric tracking object id for this guest.protected GregorianCalendar
modifyDate
The date a virtual computing instance was last modified.protected boolean
modifyDateSpecified
protected Stratum
monitoringServiceComponent
A virtual guest's network monitoring services.protected List<Guest>
monitoringUserNotification
The monitoring notification objects for this guest.protected Long
monitoringUserNotificationCount
A count of the monitoring notification objects for this guest.protected Long
networkComponentCount
A count of a guests's network components.protected List<Component>
networkComponents
A guests's network components.protected Long
networkMonitorCount
A count of a guests's network monitors.protected Long
networkMonitorIncidentCount
A count of all of a virtual guest's network monitoring incidents.protected List<Incident>
networkMonitorIncidents
All of a virtual guest's network monitoring incidents.protected List<Host>
networkMonitors
A guests's network monitors.protected List<Storage>
networkStorage
A guest's associated network storage accounts.protected Long
networkStorageCount
A count of a guest's associated network storage accounts.protected Long
networkVlanCount
A count of the network Vlans that a guest's network components are associated with.protected List<Vlan>
networkVlans
The network Vlans that a guest's network components are associated with.protected String
notes
A note of up to 1,000 characters about a virtual server.protected boolean
notesSpecified
protected Ticket
openCancellationTicket
An open ticket requesting cancellation of this server, if one exists.protected OperatingSystem
operatingSystem
A guest's operating system.protected String
operatingSystemReferenceCode
A guest's operating system software description.protected String
orderedPackageId
The original package id provided with the order for a Cloud Computing Instance.protected BigDecimal
outboundPrivateBandwidthUsage
The total private outbound bandwidth for this computing instance for the current billing cycle.protected BigDecimal
outboundPublicBandwidthUsage
The total public outbound bandwidth for this computing instance for the current billing cycle.protected Long
overBandwidthAllocationFlag
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.protected Boolean
pendingMigrationFlag
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.protected PlacementGroup
placementGroup
The placement group that a virtual guest belongs to.protected Long
placementGroupId
The placement group ID that the virtual guest belongs to.protected boolean
placementGroupIdSpecified
protected String
postInstallScriptUri
URI of the script to be downloaded and executed after installation is complete.protected boolean
postInstallScriptUriSpecified
protected State
powerState
The current power state of a virtual guest.protected String
primaryBackendIpAddress
A guest's primary private IP address.protected Component
primaryBackendNetworkComponent
A guest's primary backend network component.protected String
primaryIpAddress
The guest's primary public IP address.protected Component
primaryNetworkComponent
A guest's primary public network component.protected Boolean
privateNetworkOnlyFlag
Whether the computing instance only has access to the private network.protected Long
projectedOverBandwidthAllocationFlag
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.protected BigDecimal
projectedPublicBandwidthUsage
The projected public outbound bandwidth for this computing instance for the current billing cycle.protected GregorianCalendar
provisionDate
protected boolean
provisionDateSpecified
protected Long
recentEventCount
A count of recent events that impact this computing instance.protected List<Event>
recentEvents
Recent events that impact this computing instance.protected Regional
regionalGroup
The regional group this guest is in.protected Registry
regionalInternetRegistry
protected ReservedCapacityGroup
reservedCapacityGroup
The reserved capacity group the guest is associated with.protected Boolean
reservedCapacityGroupFlag
Flag to indicate whether or not a guest is part of a reserved capacity group.protected Instance
reservedCapacityGroupInstance
The reserved capacity group instance the guest is associated with.protected Long
scaleAssetCount
A count of collection of scale assets this guest corresponds to.protected List<Asset>
scaleAssets
Collection of scale assets this guest corresponds to.protected Boolean
scaledFlag
Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.protected Guest
scaleMember
The scale member for this guest, if applicable.protected Long
securityScanRequestCount
A count of a guest's vulnerability scan requests.protected List<Request>
securityScanRequests
A guest's vulnerability scan requests.protected Location
serverRoom
The server room that a guest is located at.protected Long
softwareComponentCount
A count of a guest's installed software.protected List<Component>
softwareComponents
A guest's installed software.protected Long
sshKeyCount
A count of sSH keys to be installed on the server during provisioning or an OS reload.protected List<Key>
sshKeys
SSH keys to be installed on the server during provisioning or an OS reload.protected Long
startCpus
The number of CPUs available to a computing instance upon startup.protected boolean
startCpusSpecified
protected Status
status
A computing instance's status.protected Long
statusId
A computing instances [[SoftLayer_Virtual_Guest_Status|status]] IDprotected boolean
statusIdSpecified
protected SupplementalCreateObjectOptions
supplementalCreateObjectOptions
Extra options needed for [[SoftLayer_Virtual_Guest/createObject|createObject]] and [[SoftLayer_Virtual_Guest/createObjects|createObjects]].protected boolean
supplementalCreateObjectOptionsSpecified
protected Long
tagReferenceCount
A count ofprotected List<Reference>
tagReferences
protected Boolean
transientGuestFlag
Whether or not a computing instance is a Transient Instance.protected Attribute
transientWebhookURI
The endpoint used to notify customers their transient guest is terminating.protected Type
type
The type of this virtual guest.protected Long
typeId
Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE.protected boolean
typeIdSpecified
protected Request
upgradeRequest
A computing instance's associated upgrade request object if any.protected Long
userCount
A count of a list of users that have access to this computing instance.protected List<Attribute>
userData
A base64 encoded string containing custom user data for a Cloud Computing Instance order.protected Long
userDataCount
A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order.protected List<Customer>
users
A list of users that have access to this computing instance.protected String
uuid
Unique ID for a computing instance's record on a virtualization platform.protected boolean
uuidSpecified
protected Allotment
virtualRack
The name of the bandwidth allotment that a hardware belongs too.protected Long
virtualRackId
The id of the bandwidth allotment that a computing instance belongs too.protected String
virtualRackName
The name of the bandwidth allotment that a computing instance belongs too. -
Constructor Summary
Constructors Constructor Description Guest()
-
Method Summary
-
Field Details
-
account
The account that a virtual guest belongs to. -
accountOwnedPoolFlag
-
activeNetworkMonitorIncident
A virtual guest's currently active network monitoring incidents. -
activeTickets
-
activeTransaction
A transaction that is still be performed on a cloud server. -
activeTransactions
Any active transaction(s) that are currently running for the server (example: os reload). -
allowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists. -
allowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. -
allowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. -
antivirusSpywareSoftwareComponent
A antivirus / spyware software component object. -
applicationDeliveryController
-
attributes
-
availableMonitoring
An object that stores the maximum level for the monitoring query types and response types. -
averageDailyPrivateBandwidthUsage
The average daily private bandwidth usage for the current billing cycle. -
averageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle. -
backendNetworkComponents
A guests's backend network components. -
backendRouters
A guest's backend or private router. -
bandwidthAllocation
A computing instance's allotted bandwidth (measured in GB). -
bandwidthAllotmentDetail
A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments. -
billingCycleBandwidthUsage
The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -
billingCyclePrivateBandwidthUsage
The raw private bandwidth usage data for the current billing cycle. -
billingCyclePublicBandwidthUsage
The raw public bandwidth usage data for the current billing cycle. -
billingItem
The billing item for a CloudLayer Compute Instance. -
blockCancelBecauseDisconnectedFlag
Determines whether the instance is ineligible for cancellation because it is disconnected. -
blockDeviceTemplateGroup
The global identifier for the image template that was used to provision or reload a guest. -
blockDevices
A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances. -
consoleIpAddressFlag
A flag indicating a computing instance's console IP address is assigned. -
consoleIpAddressRecord
A record containing information about a computing instance's console IP and port number. -
continuousDataProtectionSoftwareComponent
A continuous data protection software component object. -
controlPanel
A guest's control panel. -
currentBandwidthSummary
An object that provides commonly used bandwidth summary components for the current billing cycle. -
datacenter
The datacenter that a virtual guest resides in. -
dedicatedHost
The dedicated host associated with this guest. -
evaultNetworkStorage
A guest's associated EVault network storage service account. -
firewallServiceComponent
A computing instance's hardware firewall services. -
frontendNetworkComponents
A guest's frontend network components. -
frontendRouters
A guest's frontend or public router. -
globalIdentifier
A guest's universally unique identifier. -
gpuCount
The number of GPUs attached to the guest. -
gpuType
The name of the GPU type attached to the guest. -
guestBootParameter
-
host
The virtual host on which a virtual guest resides (available only on private clouds). -
hostIpsSoftwareComponent
A host IPS software component object. -
hourlyBillingFlag
A guest's hourly billing status. -
inboundPrivateBandwidthUsage
The total private inbound bandwidth for this computing instance for the current billing cycle. -
inboundPublicBandwidthUsage
The total public inbound bandwidth for this computing instance for the current billing cycle. -
internalTagReferences
-
lastKnownPowerState
The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. -
lastOperatingSystemReload
The last transaction that a cloud server's operating system was loaded. -
lastTransaction
The last transaction a cloud server had performed. -
latestNetworkMonitorIncident
A virtual guest's latest network monitoring incident. -
localDiskFlag
A flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device. -
location
Where guest is located within SoftLayer's location hierarchy. -
managedResourceFlag
A flag indicating that the virtual guest is a managed resource. -
metricTrackingObject
A guest's metric tracking object. -
metricTrackingObjectId
The metric tracking object id for this guest. -
monitoringServiceComponent
A virtual guest's network monitoring services. -
monitoringUserNotification
The monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails -
networkComponents
A guests's network components. -
networkMonitorIncidents
All of a virtual guest's network monitoring incidents. -
networkMonitors
A guests's network monitors. -
networkStorage
A guest's associated network storage accounts. -
networkVlans
The network Vlans that a guest's network components are associated with. -
openCancellationTicket
An open ticket requesting cancellation of this server, if one exists. -
operatingSystem
A guest's operating system. -
operatingSystemReferenceCode
A guest's operating system software description. -
orderedPackageId
The original package id provided with the order for a Cloud Computing Instance. -
outboundPrivateBandwidthUsage
The total private outbound bandwidth for this computing instance for the current billing cycle. -
outboundPublicBandwidthUsage
The total public outbound bandwidth for this computing instance for the current billing cycle. -
overBandwidthAllocationFlag
Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation. -
pendingMigrationFlag
When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate. -
placementGroup
The placement group that a virtual guest belongs to. -
powerState
The current power state of a virtual guest. -
primaryBackendIpAddress
A guest's primary private IP address. -
primaryBackendNetworkComponent
A guest's primary backend network component. -
primaryIpAddress
The guest's primary public IP address. -
primaryNetworkComponent
A guest's primary public network component. -
privateNetworkOnlyFlag
Whether the computing instance only has access to the private network. -
projectedOverBandwidthAllocationFlag
Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation. -
projectedPublicBandwidthUsage
The projected public outbound bandwidth for this computing instance for the current billing cycle. -
recentEvents
Recent events that impact this computing instance. -
regionalGroup
The regional group this guest is in. -
regionalInternetRegistry
-
reservedCapacityGroup
The reserved capacity group the guest is associated with. -
reservedCapacityGroupFlag
Flag to indicate whether or not a guest is part of a reserved capacity group. -
reservedCapacityGroupInstance
The reserved capacity group instance the guest is associated with. -
scaleAssets
Collection of scale assets this guest corresponds to. -
scaleMember
The scale member for this guest, if applicable. -
scaledFlag
Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action. -
securityScanRequests
A guest's vulnerability scan requests. -
serverRoom
The server room that a guest is located at. There may be more than one server room for every data center. -
softwareComponents
A guest's installed software. -
sshKeys
SSH keys to be installed on the server during provisioning or an OS reload. -
status
A computing instance's status. -
tagReferences
-
transientGuestFlag
Whether or not a computing instance is a Transient Instance. -
transientWebhookURI
The endpoint used to notify customers their transient guest is terminating. -
type
The type of this virtual guest. -
upgradeRequest
A computing instance's associated upgrade request object if any. -
userData
A base64 encoded string containing custom user data for a Cloud Computing Instance order. -
users
A list of users that have access to this computing instance. -
virtualRack
The name of the bandwidth allotment that a hardware belongs too. -
virtualRackId
The id of the bandwidth allotment that a computing instance belongs too. -
virtualRackName
The name of the bandwidth allotment that a computing instance belongs too. -
accountId
A computing instance's associated [[SoftLayer_Account|account]] id -
accountIdSpecified
protected boolean accountIdSpecified -
createDate
The date a virtual computing instance was created. -
createDateSpecified
protected boolean createDateSpecified -
dedicatedAccountHostOnlyFlag
When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. -
dedicatedAccountHostOnlyFlagSpecified
protected boolean dedicatedAccountHostOnlyFlagSpecified -
domain
A computing instance's domain name -
domainSpecified
protected boolean domainSpecified -
fullyQualifiedDomainName
A name reflecting the hostname and domain of the computing instance. -
fullyQualifiedDomainNameSpecified
protected boolean fullyQualifiedDomainNameSpecified -
hostname
A virtual computing instance's hostname -
hostnameSpecified
protected boolean hostnameSpecified -
id
Unique ID for a computing instance. -
idSpecified
protected boolean idSpecified -
lastPowerStateId
-
lastPowerStateIdSpecified
protected boolean lastPowerStateIdSpecified -
lastVerifiedDate
The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform. -
lastVerifiedDateSpecified
protected boolean lastVerifiedDateSpecified -
maxCpu
The maximum amount of CPU resources a computing instance may utilize. -
maxCpuSpecified
protected boolean maxCpuSpecified -
maxCpuUnits
The unit of the maximum amount of CPU resources a computing instance may utilize. -
maxCpuUnitsSpecified
protected boolean maxCpuUnitsSpecified -
maxMemory
The maximum amount of memory a computing instance may utilize. -
maxMemorySpecified
protected boolean maxMemorySpecified -
metricPollDate
The date of the most recent metric tracking poll performed. -
metricPollDateSpecified
protected boolean metricPollDateSpecified -
modifyDate
The date a virtual computing instance was last modified. -
modifyDateSpecified
protected boolean modifyDateSpecified -
notes
A note of up to 1,000 characters about a virtual server. -
notesSpecified
protected boolean notesSpecified -
placementGroupId
The placement group ID that the virtual guest belongs to. -
placementGroupIdSpecified
protected boolean placementGroupIdSpecified -
postInstallScriptUri
URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions' postInstallScriptUri. -
postInstallScriptUriSpecified
protected boolean postInstallScriptUriSpecified -
provisionDate
-
provisionDateSpecified
protected boolean provisionDateSpecified -
startCpus
The number of CPUs available to a computing instance upon startup. -
startCpusSpecified
protected boolean startCpusSpecified -
statusId
A computing instances [[SoftLayer_Virtual_Guest_Status|status]] ID -
statusIdSpecified
protected boolean statusIdSpecified -
supplementalCreateObjectOptions
@ApiProperty(canBeNullOrNotSet=true) protected SupplementalCreateObjectOptions supplementalCreateObjectOptionsExtra options needed for [[SoftLayer_Virtual_Guest/createObject|createObject]] and [[SoftLayer_Virtual_Guest/createObjects|createObjects]]. -
supplementalCreateObjectOptionsSpecified
protected boolean supplementalCreateObjectOptionsSpecified -
typeId
Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE. -
typeIdSpecified
protected boolean typeIdSpecified -
uuid
Unique ID for a computing instance's record on a virtualization platform. -
uuidSpecified
protected boolean uuidSpecified -
activeNetworkMonitorIncidentCount
A count of a virtual guest's currently active network monitoring incidents. -
activeTicketCount
A count of -
activeTransactionCount
A count of any active transaction(s) that are currently running for the server (example: os reload). -
allowedNetworkStorageCount
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. -
allowedNetworkStorageReplicaCount
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. -
attributeCount
A count of -
availableMonitoringCount
A count of an object that stores the maximum level for the monitoring query types and response types. -
backendNetworkComponentCount
A count of a guests's backend network components. -
backendRouterCount
A count of a guest's backend or private router. -
billingCycleBandwidthUsageCount
A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. -
blockDeviceCount
A count of a computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances. -
evaultNetworkStorageCount
A count of a guest's associated EVault network storage service account. -
frontendNetworkComponentCount
A count of a guest's frontend network components. -
internalTagReferenceCount
A count of -
monitoringUserNotificationCount
A count of the monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails -
networkComponentCount
A count of a guests's network components. -
networkMonitorCount
A count of a guests's network monitors. -
networkMonitorIncidentCount
A count of all of a virtual guest's network monitoring incidents. -
networkStorageCount
A count of a guest's associated network storage accounts. -
networkVlanCount
A count of the network Vlans that a guest's network components are associated with. -
recentEventCount
A count of recent events that impact this computing instance. -
scaleAssetCount
A count of collection of scale assets this guest corresponds to. -
securityScanRequestCount
A count of a guest's vulnerability scan requests. -
softwareComponentCount
A count of a guest's installed software. -
sshKeyCount
A count of sSH keys to be installed on the server during provisioning or an OS reload. -
tagReferenceCount
A count of -
userCount
A count of a list of users that have access to this computing instance. -
userDataCount
A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order.
-
-
Constructor Details
-
Guest
public Guest()
-
-
Method Details
-
getAccount
-
setAccount
-
getAccountOwnedPoolFlag
-
setAccountOwnedPoolFlag
-
getActiveNetworkMonitorIncident
-
getActiveTickets
-
getActiveTransaction
-
setActiveTransaction
-
getActiveTransactions
-
getAllowedHost
-
setAllowedHost
-
getAllowedNetworkStorage
-
getAllowedNetworkStorageReplicas
-
getAntivirusSpywareSoftwareComponent
-
setAntivirusSpywareSoftwareComponent
-
getApplicationDeliveryController
-
setApplicationDeliveryController
-
getAttributes
-
getAvailableMonitoring
-
getAverageDailyPrivateBandwidthUsage
-
setAverageDailyPrivateBandwidthUsage
-
getAverageDailyPublicBandwidthUsage
-
setAverageDailyPublicBandwidthUsage
-
getBackendNetworkComponents
-
getBackendRouters
-
getBandwidthAllocation
-
setBandwidthAllocation
-
getBandwidthAllotmentDetail
-
setBandwidthAllotmentDetail
-
getBillingCycleBandwidthUsage
-
getBillingCyclePrivateBandwidthUsage
-
setBillingCyclePrivateBandwidthUsage
-
getBillingCyclePublicBandwidthUsage
-
setBillingCyclePublicBandwidthUsage
-
getBillingItem
-
setBillingItem
-
getBlockCancelBecauseDisconnectedFlag
-
setBlockCancelBecauseDisconnectedFlag
-
getBlockDeviceTemplateGroup
-
setBlockDeviceTemplateGroup
-
getBlockDevices
-
getConsoleIpAddressFlag
-
setConsoleIpAddressFlag
-
getConsoleIpAddressRecord
-
setConsoleIpAddressRecord
-
getContinuousDataProtectionSoftwareComponent
-
setContinuousDataProtectionSoftwareComponent
public void setContinuousDataProtectionSoftwareComponent(Component continuousDataProtectionSoftwareComponent) -
getControlPanel
-
setControlPanel
-
getCurrentBandwidthSummary
-
setCurrentBandwidthSummary
-
getDatacenter
-
setDatacenter
-
getDedicatedHost
-
setDedicatedHost
-
getEvaultNetworkStorage
-
getFirewallServiceComponent
-
setFirewallServiceComponent
-
getFrontendNetworkComponents
-
getFrontendRouters
-
setFrontendRouters
-
getGlobalIdentifier
-
setGlobalIdentifier
-
getGpuCount
-
setGpuCount
-
getGpuType
-
setGpuType
-
getGuestBootParameter
-
setGuestBootParameter
-
getHost
-
setHost
-
getHostIpsSoftwareComponent
-
setHostIpsSoftwareComponent
-
getHourlyBillingFlag
-
setHourlyBillingFlag
-
getInboundPrivateBandwidthUsage
-
setInboundPrivateBandwidthUsage
-
getInboundPublicBandwidthUsage
-
setInboundPublicBandwidthUsage
-
getInternalTagReferences
-
getLastKnownPowerState
-
setLastKnownPowerState
-
getLastOperatingSystemReload
-
setLastOperatingSystemReload
-
getLastTransaction
-
setLastTransaction
-
getLatestNetworkMonitorIncident
-
setLatestNetworkMonitorIncident
-
getLocalDiskFlag
-
setLocalDiskFlag
-
getLocation
-
setLocation
-
getManagedResourceFlag
-
setManagedResourceFlag
-
getMetricTrackingObject
-
setMetricTrackingObject
-
getMetricTrackingObjectId
-
setMetricTrackingObjectId
-
getMonitoringServiceComponent
-
setMonitoringServiceComponent
-
getMonitoringUserNotification
-
getNetworkComponents
-
getNetworkMonitorIncidents
-
getNetworkMonitors
-
getNetworkStorage
-
getNetworkVlans
-
getOpenCancellationTicket
-
setOpenCancellationTicket
-
getOperatingSystem
-
setOperatingSystem
-
getOperatingSystemReferenceCode
-
setOperatingSystemReferenceCode
-
getOrderedPackageId
-
setOrderedPackageId
-
getOutboundPrivateBandwidthUsage
-
setOutboundPrivateBandwidthUsage
-
getOutboundPublicBandwidthUsage
-
setOutboundPublicBandwidthUsage
-
getOverBandwidthAllocationFlag
-
setOverBandwidthAllocationFlag
-
getPendingMigrationFlag
-
setPendingMigrationFlag
-
getPlacementGroup
-
setPlacementGroup
-
getPowerState
-
setPowerState
-
getPrimaryBackendIpAddress
-
setPrimaryBackendIpAddress
-
getPrimaryBackendNetworkComponent
-
setPrimaryBackendNetworkComponent
-
getPrimaryIpAddress
-
setPrimaryIpAddress
-
getPrimaryNetworkComponent
-
setPrimaryNetworkComponent
-
getPrivateNetworkOnlyFlag
-
setPrivateNetworkOnlyFlag
-
getProjectedOverBandwidthAllocationFlag
-
setProjectedOverBandwidthAllocationFlag
-
getProjectedPublicBandwidthUsage
-
setProjectedPublicBandwidthUsage
-
getRecentEvents
-
getRegionalGroup
-
setRegionalGroup
-
getRegionalInternetRegistry
-
setRegionalInternetRegistry
-
getReservedCapacityGroup
-
setReservedCapacityGroup
-
getReservedCapacityGroupFlag
-
setReservedCapacityGroupFlag
-
getReservedCapacityGroupInstance
-
setReservedCapacityGroupInstance
-
getScaleAssets
-
getScaleMember
-
setScaleMember
-
getScaledFlag
-
setScaledFlag
-
getSecurityScanRequests
-
getServerRoom
-
setServerRoom
-
getSoftwareComponents
-
getSshKeys
-
getStatus
-
setStatus
-
getTagReferences
-
getTransientGuestFlag
-
setTransientGuestFlag
-
getTransientWebhookURI
-
setTransientWebhookURI
-
getType
-
setType
-
getUpgradeRequest
-
setUpgradeRequest
-
getUserData
-
getUsers
-
getVirtualRack
-
setVirtualRack
-
getVirtualRackId
-
setVirtualRackId
-
getVirtualRackName
-
setVirtualRackName
-
getAccountId
-
setAccountId
-
isAccountIdSpecified
public boolean isAccountIdSpecified() -
unsetAccountId
public void unsetAccountId() -
getCreateDate
-
setCreateDate
-
isCreateDateSpecified
public boolean isCreateDateSpecified() -
unsetCreateDate
public void unsetCreateDate() -
getDedicatedAccountHostOnlyFlag
-
setDedicatedAccountHostOnlyFlag
-
isDedicatedAccountHostOnlyFlagSpecified
public boolean isDedicatedAccountHostOnlyFlagSpecified() -
unsetDedicatedAccountHostOnlyFlag
public void unsetDedicatedAccountHostOnlyFlag() -
getDomain
-
setDomain
-
isDomainSpecified
public boolean isDomainSpecified() -
unsetDomain
public void unsetDomain() -
getFullyQualifiedDomainName
-
setFullyQualifiedDomainName
-
isFullyQualifiedDomainNameSpecified
public boolean isFullyQualifiedDomainNameSpecified() -
unsetFullyQualifiedDomainName
public void unsetFullyQualifiedDomainName() -
getHostname
-
setHostname
-
isHostnameSpecified
public boolean isHostnameSpecified() -
unsetHostname
public void unsetHostname() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getLastPowerStateId
-
setLastPowerStateId
-
isLastPowerStateIdSpecified
public boolean isLastPowerStateIdSpecified() -
unsetLastPowerStateId
public void unsetLastPowerStateId() -
getLastVerifiedDate
-
setLastVerifiedDate
-
isLastVerifiedDateSpecified
public boolean isLastVerifiedDateSpecified() -
unsetLastVerifiedDate
public void unsetLastVerifiedDate() -
getMaxCpu
-
setMaxCpu
-
isMaxCpuSpecified
public boolean isMaxCpuSpecified() -
unsetMaxCpu
public void unsetMaxCpu() -
getMaxCpuUnits
-
setMaxCpuUnits
-
isMaxCpuUnitsSpecified
public boolean isMaxCpuUnitsSpecified() -
unsetMaxCpuUnits
public void unsetMaxCpuUnits() -
getMaxMemory
-
setMaxMemory
-
isMaxMemorySpecified
public boolean isMaxMemorySpecified() -
unsetMaxMemory
public void unsetMaxMemory() -
getMetricPollDate
-
setMetricPollDate
-
isMetricPollDateSpecified
public boolean isMetricPollDateSpecified() -
unsetMetricPollDate
public void unsetMetricPollDate() -
getModifyDate
-
setModifyDate
-
isModifyDateSpecified
public boolean isModifyDateSpecified() -
unsetModifyDate
public void unsetModifyDate() -
getNotes
-
setNotes
-
isNotesSpecified
public boolean isNotesSpecified() -
unsetNotes
public void unsetNotes() -
getPlacementGroupId
-
setPlacementGroupId
-
isPlacementGroupIdSpecified
public boolean isPlacementGroupIdSpecified() -
unsetPlacementGroupId
public void unsetPlacementGroupId() -
getPostInstallScriptUri
-
setPostInstallScriptUri
-
isPostInstallScriptUriSpecified
public boolean isPostInstallScriptUriSpecified() -
unsetPostInstallScriptUri
public void unsetPostInstallScriptUri() -
getProvisionDate
-
setProvisionDate
-
isProvisionDateSpecified
public boolean isProvisionDateSpecified() -
unsetProvisionDate
public void unsetProvisionDate() -
getStartCpus
-
setStartCpus
-
isStartCpusSpecified
public boolean isStartCpusSpecified() -
unsetStartCpus
public void unsetStartCpus() -
getStatusId
-
setStatusId
-
isStatusIdSpecified
public boolean isStatusIdSpecified() -
unsetStatusId
public void unsetStatusId() -
getSupplementalCreateObjectOptions
-
setSupplementalCreateObjectOptions
public void setSupplementalCreateObjectOptions(SupplementalCreateObjectOptions supplementalCreateObjectOptions) -
isSupplementalCreateObjectOptionsSpecified
public boolean isSupplementalCreateObjectOptionsSpecified() -
unsetSupplementalCreateObjectOptions
public void unsetSupplementalCreateObjectOptions() -
getTypeId
-
setTypeId
-
isTypeIdSpecified
public boolean isTypeIdSpecified() -
unsetTypeId
public void unsetTypeId() -
getUuid
-
setUuid
-
isUuidSpecified
public boolean isUuidSpecified() -
unsetUuid
public void unsetUuid() -
getActiveNetworkMonitorIncidentCount
-
setActiveNetworkMonitorIncidentCount
-
getActiveTicketCount
-
setActiveTicketCount
-
getActiveTransactionCount
-
setActiveTransactionCount
-
getAllowedNetworkStorageCount
-
setAllowedNetworkStorageCount
-
getAllowedNetworkStorageReplicaCount
-
setAllowedNetworkStorageReplicaCount
-
getAttributeCount
-
setAttributeCount
-
getAvailableMonitoringCount
-
setAvailableMonitoringCount
-
getBackendNetworkComponentCount
-
setBackendNetworkComponentCount
-
getBackendRouterCount
-
setBackendRouterCount
-
getBillingCycleBandwidthUsageCount
-
setBillingCycleBandwidthUsageCount
-
getBlockDeviceCount
-
setBlockDeviceCount
-
getEvaultNetworkStorageCount
-
setEvaultNetworkStorageCount
-
getFrontendNetworkComponentCount
-
setFrontendNetworkComponentCount
-
getInternalTagReferenceCount
-
setInternalTagReferenceCount
-
getMonitoringUserNotificationCount
-
setMonitoringUserNotificationCount
-
getNetworkComponentCount
-
setNetworkComponentCount
-
getNetworkMonitorCount
-
setNetworkMonitorCount
-
getNetworkMonitorIncidentCount
-
setNetworkMonitorIncidentCount
-
getNetworkStorageCount
-
setNetworkStorageCount
-
getNetworkVlanCount
-
setNetworkVlanCount
-
getRecentEventCount
-
setRecentEventCount
-
getScaleAssetCount
-
setScaleAssetCount
-
getSecurityScanRequestCount
-
setSecurityScanRequestCount
-
getSoftwareComponentCount
-
setSoftwareComponentCount
-
getSshKeyCount
-
setSshKeyCount
-
getTagReferenceCount
-
setTagReferenceCount
-
getUserCount
-
setUserCount
-
getUserDataCount
-
setUserDataCount
-
asService
-
service
-
service
-
service
-