• Home
• com.softlayer.api
• softlayer-api-client
• 0.2.0
• source code
• Guest.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.softlayer.api.service.virtual.Guest Maven / Gradle / Ivy

package com.softlayer.api.service.virtual;

import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.Ticket;
import com.softlayer.api.service.container.Graph;
import com.softlayer.api.service.container.bandwidth.GraphOutputs;
import com.softlayer.api.service.container.disk.image.capture.Template;
import com.softlayer.api.service.container.hardware.server.Configuration;
import com.softlayer.api.service.container.monitoring.alarm.History;
import com.softlayer.api.service.container.product.Order;
import com.softlayer.api.service.dns.Domain;
import com.softlayer.api.service.location.group.Regional;
import com.softlayer.api.service.metric.tracking.Object;
import com.softlayer.api.service.metric.tracking.object.Data;
import com.softlayer.api.service.metric.tracking.object.bandwidth.Summary;
import com.softlayer.api.service.monitoring.Agent;
import com.softlayer.api.service.monitoring.Robot;
import com.softlayer.api.service.network.Storage;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.application.delivery.Controller;
import com.softlayer.api.service.network.bandwidth.Usage;
import com.softlayer.api.service.network.bandwidth.version1.Allotment;
import com.softlayer.api.service.network.bandwidth.version1.allotment.Detail;
import com.softlayer.api.service.network.component.Firewall;
import com.softlayer.api.service.network.logging.Syslog;
import com.softlayer.api.service.network.monitor.version1.Incident;
import com.softlayer.api.service.network.monitor.version1.query.Host;
import com.softlayer.api.service.network.monitor.version1.query.host.Stratum;
import com.softlayer.api.service.network.regional.internet.Registry;
import com.softlayer.api.service.network.subnet.IpAddress;
import com.softlayer.api.service.notification.occurrence.Event;
import com.softlayer.api.service.product.Item;
import com.softlayer.api.service.product.item.Price;
import com.softlayer.api.service.product.upgrade.Request;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.scale.Asset;
import com.softlayer.api.service.security.ssh.Key;
import com.softlayer.api.service.software.Component;
import com.softlayer.api.service.software.Description;
import com.softlayer.api.service.software.component.OperatingSystem;
import com.softlayer.api.service.tag.Reference;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.virtual.disk.Image;
import com.softlayer.api.service.virtual.guest.Attribute;
import com.softlayer.api.service.virtual.guest.Status;
import com.softlayer.api.service.virtual.guest.SupplementalCreateObjectOptions;
import com.softlayer.api.service.virtual.guest.block.Device;
import com.softlayer.api.service.virtual.guest.block.device.template.Group;
import com.softlayer.api.service.virtual.guest.boot.Parameter;
import com.softlayer.api.service.virtual.guest.power.State;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;

/**
 * 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. 
 *
 * @see SoftLayer_Virtual_Guest
 */
@ApiType("SoftLayer_Virtual_Guest")
public class Guest extends Entity {

    /**
     * The account that a virtual guest belongs to.
     */
    @ApiProperty
    protected Account account;

    public Account getAccount() {
        return account;
    }

    public void setAccount(Account account) {
        this.account = account;
    }

    @ApiProperty
    protected Boolean accountOwnedPoolFlag;

    public Boolean getAccountOwnedPoolFlag() {
        return accountOwnedPoolFlag;
    }

    public void setAccountOwnedPoolFlag(Boolean accountOwnedPoolFlag) {
        this.accountOwnedPoolFlag = accountOwnedPoolFlag;
    }

    /**
     * A virtual guest's currently active network monitoring incidents.
     */
    @ApiProperty
    protected List activeNetworkMonitorIncident;

    public List getActiveNetworkMonitorIncident() {
        if (activeNetworkMonitorIncident == null) {
            activeNetworkMonitorIncident = new ArrayList();
        }
        return activeNetworkMonitorIncident;
    }

    @ApiProperty
    protected List activeTickets;

    public List getActiveTickets() {
        if (activeTickets == null) {
            activeTickets = new ArrayList();
        }
        return activeTickets;
    }

    /**
     * A transaction that is still be performed on a cloud server.
     */
    @ApiProperty
    protected Transaction activeTransaction;

    public Transaction getActiveTransaction() {
        return activeTransaction;
    }

    public void setActiveTransaction(Transaction activeTransaction) {
        this.activeTransaction = activeTransaction;
    }

    /**
     * Any active transaction(s) that are currently running for the server (example: os reload).
     */
    @ApiProperty
    protected List activeTransactions;

    public List getActiveTransactions() {
        if (activeTransactions == null) {
            activeTransactions = new ArrayList();
        }
        return activeTransactions;
    }

    /**
     * The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
     */
    @ApiProperty
    protected com.softlayer.api.service.network.storage.allowed.Host allowedHost;

    public com.softlayer.api.service.network.storage.allowed.Host getAllowedHost() {
        return allowedHost;
    }

    public void setAllowedHost(com.softlayer.api.service.network.storage.allowed.Host allowedHost) {
        this.allowedHost = allowedHost;
    }

    /**
     * The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
     */
    @ApiProperty
    protected List allowedNetworkStorage;

    public List getAllowedNetworkStorage() {
        if (allowedNetworkStorage == null) {
            allowedNetworkStorage = new ArrayList();
        }
        return allowedNetworkStorage;
    }

    /**
     * A antivirus / spyware software component object.
     */
    @ApiProperty
    protected Component antivirusSpywareSoftwareComponent;

    public Component getAntivirusSpywareSoftwareComponent() {
        return antivirusSpywareSoftwareComponent;
    }

    public void setAntivirusSpywareSoftwareComponent(Component antivirusSpywareSoftwareComponent) {
        this.antivirusSpywareSoftwareComponent = antivirusSpywareSoftwareComponent;
    }

    @ApiProperty
    protected Controller applicationDeliveryController;

    public Controller getApplicationDeliveryController() {
        return applicationDeliveryController;
    }

    public void setApplicationDeliveryController(Controller applicationDeliveryController) {
        this.applicationDeliveryController = applicationDeliveryController;
    }

    @ApiProperty
    protected List attributes;

    public List getAttributes() {
        if (attributes == null) {
            attributes = new ArrayList();
        }
        return attributes;
    }

    /**
     * An object that stores the maximum level for the monitoring query types and response types.
     */
    @ApiProperty
    protected List availableMonitoring;

    public List getAvailableMonitoring() {
        if (availableMonitoring == null) {
            availableMonitoring = new ArrayList();
        }
        return availableMonitoring;
    }

    /**
     * The average daily private bandwidth usage for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal averageDailyPrivateBandwidthUsage;

    public BigDecimal getAverageDailyPrivateBandwidthUsage() {
        return averageDailyPrivateBandwidthUsage;
    }

    public void setAverageDailyPrivateBandwidthUsage(BigDecimal averageDailyPrivateBandwidthUsage) {
        this.averageDailyPrivateBandwidthUsage = averageDailyPrivateBandwidthUsage;
    }

    /**
     * The average daily public bandwidth usage for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal averageDailyPublicBandwidthUsage;

    public BigDecimal getAverageDailyPublicBandwidthUsage() {
        return averageDailyPublicBandwidthUsage;
    }

    public void setAverageDailyPublicBandwidthUsage(BigDecimal averageDailyPublicBandwidthUsage) {
        this.averageDailyPublicBandwidthUsage = averageDailyPublicBandwidthUsage;
    }

    /**
     * A guests's backend network components.
     */
    @ApiProperty
    protected List backendNetworkComponents;

    public List getBackendNetworkComponents() {
        if (backendNetworkComponents == null) {
            backendNetworkComponents = new ArrayList();
        }
        return backendNetworkComponents;
    }

    /**
     * A guest's backend or private router.
     */
    @ApiProperty
    protected List backendRouters;

    public List getBackendRouters() {
        if (backendRouters == null) {
            backendRouters = new ArrayList();
        }
        return backendRouters;
    }

    /**
     * A computing instance's allotted bandwidth (measured in GB).
     */
    @ApiProperty
    protected BigDecimal bandwidthAllocation;

    public BigDecimal getBandwidthAllocation() {
        return bandwidthAllocation;
    }

    public void setBandwidthAllocation(BigDecimal bandwidthAllocation) {
        this.bandwidthAllocation = bandwidthAllocation;
    }

    /**
     * A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.
     */
    @ApiProperty
    protected Detail bandwidthAllotmentDetail;

    public Detail getBandwidthAllotmentDetail() {
        return bandwidthAllotmentDetail;
    }

    public void setBandwidthAllotmentDetail(Detail bandwidthAllotmentDetail) {
        this.bandwidthAllotmentDetail = bandwidthAllotmentDetail;
    }

    /**
     * The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
     */
    @ApiProperty
    protected List billingCycleBandwidthUsage;

    public List getBillingCycleBandwidthUsage() {
        if (billingCycleBandwidthUsage == null) {
            billingCycleBandwidthUsage = new ArrayList();
        }
        return billingCycleBandwidthUsage;
    }

    /**
     * The raw private bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected Usage billingCyclePrivateBandwidthUsage;

    public Usage getBillingCyclePrivateBandwidthUsage() {
        return billingCyclePrivateBandwidthUsage;
    }

    public void setBillingCyclePrivateBandwidthUsage(Usage billingCyclePrivateBandwidthUsage) {
        this.billingCyclePrivateBandwidthUsage = billingCyclePrivateBandwidthUsage;
    }

    /**
     * The raw public bandwidth usage data for the current billing cycle.
     */
    @ApiProperty
    protected Usage billingCyclePublicBandwidthUsage;

    public Usage getBillingCyclePublicBandwidthUsage() {
        return billingCyclePublicBandwidthUsage;
    }

    public void setBillingCyclePublicBandwidthUsage(Usage billingCyclePublicBandwidthUsage) {
        this.billingCyclePublicBandwidthUsage = billingCyclePublicBandwidthUsage;
    }

    /**
     * The billing item for a CloudLayer Compute Instance.
     */
    @ApiProperty
    protected com.softlayer.api.service.billing.item.virtual.Guest billingItem;

    public com.softlayer.api.service.billing.item.virtual.Guest getBillingItem() {
        return billingItem;
    }

    public void setBillingItem(com.softlayer.api.service.billing.item.virtual.Guest billingItem) {
        this.billingItem = billingItem;
    }

    /**
     * Determines whether the instance is ineligible for cancellation because it is disconnected.
     */
    @ApiProperty
    protected Boolean blockCancelBecauseDisconnectedFlag;

    public Boolean getBlockCancelBecauseDisconnectedFlag() {
        return blockCancelBecauseDisconnectedFlag;
    }

    public void setBlockCancelBecauseDisconnectedFlag(Boolean blockCancelBecauseDisconnectedFlag) {
        this.blockCancelBecauseDisconnectedFlag = blockCancelBecauseDisconnectedFlag;
    }

    /**
     * The global identifier for the image template that was used to provision a guest.
     */
    @ApiProperty
    protected Group blockDeviceTemplateGroup;

    public Group getBlockDeviceTemplateGroup() {
        return blockDeviceTemplateGroup;
    }

    public void setBlockDeviceTemplateGroup(Group blockDeviceTemplateGroup) {
        this.blockDeviceTemplateGroup = blockDeviceTemplateGroup;
    }

    /**
     * A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.
     */
    @ApiProperty
    protected List blockDevices;

    public List getBlockDevices() {
        if (blockDevices == null) {
            blockDevices = new ArrayList();
        }
        return blockDevices;
    }

    /**
     * A flag indicating a computing instance's console IP address is assigned.
     */
    @ApiProperty
    protected Boolean consoleIpAddressFlag;

    public Boolean getConsoleIpAddressFlag() {
        return consoleIpAddressFlag;
    }

    public void setConsoleIpAddressFlag(Boolean consoleIpAddressFlag) {
        this.consoleIpAddressFlag = consoleIpAddressFlag;
    }

    /**
     * A record containing information about a computing instance's console IP and port number.
     */
    @ApiProperty
    protected com.softlayer.api.service.virtual.guest.network.component.IpAddress consoleIpAddressRecord;

    public com.softlayer.api.service.virtual.guest.network.component.IpAddress getConsoleIpAddressRecord() {
        return consoleIpAddressRecord;
    }

    public void setConsoleIpAddressRecord(com.softlayer.api.service.virtual.guest.network.component.IpAddress consoleIpAddressRecord) {
        this.consoleIpAddressRecord = consoleIpAddressRecord;
    }

    /**
     * A continuous data protection software component object.
     */
    @ApiProperty
    protected Component continuousDataProtectionSoftwareComponent;

    public Component getContinuousDataProtectionSoftwareComponent() {
        return continuousDataProtectionSoftwareComponent;
    }

    public void setContinuousDataProtectionSoftwareComponent(Component continuousDataProtectionSoftwareComponent) {
        this.continuousDataProtectionSoftwareComponent = continuousDataProtectionSoftwareComponent;
    }

    /**
     * A guest's control panel.
     */
    @ApiProperty
    protected Component controlPanel;

    public Component getControlPanel() {
        return controlPanel;
    }

    public void setControlPanel(Component controlPanel) {
        this.controlPanel = controlPanel;
    }

    /**
     * An object that provides commonly used bandwidth summary components for the current billing cycle.
     */
    @ApiProperty
    protected Summary currentBandwidthSummary;

    public Summary getCurrentBandwidthSummary() {
        return currentBandwidthSummary;
    }

    public void setCurrentBandwidthSummary(Summary currentBandwidthSummary) {
        this.currentBandwidthSummary = currentBandwidthSummary;
    }

    /**
     * The datacenter that a virtual guest resides in.
     */
    @ApiProperty
    protected Location datacenter;

    public Location getDatacenter() {
        return datacenter;
    }

    public void setDatacenter(Location datacenter) {
        this.datacenter = datacenter;
    }

    /**
     * A guest's associated EVault network storage service account.
     */
    @ApiProperty
    protected List evaultNetworkStorage;

    public List getEvaultNetworkStorage() {
        if (evaultNetworkStorage == null) {
            evaultNetworkStorage = new ArrayList();
        }
        return evaultNetworkStorage;
    }

    /**
     * A computing instance's hardware firewall services.
     */
    @ApiProperty
    protected Firewall firewallServiceComponent;

    public Firewall getFirewallServiceComponent() {
        return firewallServiceComponent;
    }

    public void setFirewallServiceComponent(Firewall firewallServiceComponent) {
        this.firewallServiceComponent = firewallServiceComponent;
    }

    /**
     * A guest's frontend network components.
     */
    @ApiProperty
    protected List frontendNetworkComponents;

    public List getFrontendNetworkComponents() {
        if (frontendNetworkComponents == null) {
            frontendNetworkComponents = new ArrayList();
        }
        return frontendNetworkComponents;
    }

    /**
     * A guest's frontend or public router.
     */
    @ApiProperty
    protected Hardware frontendRouters;

    public Hardware getFrontendRouters() {
        return frontendRouters;
    }

    public void setFrontendRouters(Hardware frontendRouters) {
        this.frontendRouters = frontendRouters;
    }

    /**
     * A guest's universally unique identifier.
     */
    @ApiProperty
    protected String globalIdentifier;

    public String getGlobalIdentifier() {
        return globalIdentifier;
    }

    public void setGlobalIdentifier(String globalIdentifier) {
        this.globalIdentifier = globalIdentifier;
    }

    @ApiProperty
    protected Parameter guestBootParameter;

    public Parameter getGuestBootParameter() {
        return guestBootParameter;
    }

    public void setGuestBootParameter(Parameter guestBootParameter) {
        this.guestBootParameter = guestBootParameter;
    }

    /**
     * The virtual host on which a virtual guest resides.
     */
    @ApiProperty
    protected com.softlayer.api.service.virtual.Host host;

    public com.softlayer.api.service.virtual.Host getHost() {
        return host;
    }

    public void setHost(com.softlayer.api.service.virtual.Host host) {
        this.host = host;
    }

    /**
     * A host IPS software component object.
     */
    @ApiProperty
    protected Component hostIpsSoftwareComponent;

    public Component getHostIpsSoftwareComponent() {
        return hostIpsSoftwareComponent;
    }

    public void setHostIpsSoftwareComponent(Component hostIpsSoftwareComponent) {
        this.hostIpsSoftwareComponent = hostIpsSoftwareComponent;
    }

    /**
     * Whether or not a computing instance is billed hourly instead of monthly.
     */
    @ApiProperty
    protected Boolean hourlyBillingFlag;

    public Boolean getHourlyBillingFlag() {
        return hourlyBillingFlag;
    }

    public void setHourlyBillingFlag(Boolean hourlyBillingFlag) {
        this.hourlyBillingFlag = hourlyBillingFlag;
    }

    /**
     * The total private inbound bandwidth for this computing instance for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal inboundPrivateBandwidthUsage;

    public BigDecimal getInboundPrivateBandwidthUsage() {
        return inboundPrivateBandwidthUsage;
    }

    public void setInboundPrivateBandwidthUsage(BigDecimal inboundPrivateBandwidthUsage) {
        this.inboundPrivateBandwidthUsage = inboundPrivateBandwidthUsage;
    }

    /**
     * The total public inbound bandwidth for this computing instance for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal inboundPublicBandwidthUsage;

    public BigDecimal getInboundPublicBandwidthUsage() {
        return inboundPublicBandwidthUsage;
    }

    public void setInboundPublicBandwidthUsage(BigDecimal inboundPublicBandwidthUsage) {
        this.inboundPublicBandwidthUsage = inboundPublicBandwidthUsage;
    }

    @ApiProperty
    protected List internalTagReferences;

    public List getInternalTagReferences() {
        if (internalTagReferences == null) {
            internalTagReferences = new ArrayList();
        }
        return internalTagReferences;
    }

    /**
     * The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.
     */
    @ApiProperty
    protected State lastKnownPowerState;

    public State getLastKnownPowerState() {
        return lastKnownPowerState;
    }

    public void setLastKnownPowerState(State lastKnownPowerState) {
        this.lastKnownPowerState = lastKnownPowerState;
    }

    /**
     * The last transaction that a cloud server's operating system was loaded.
     */
    @ApiProperty
    protected Transaction lastOperatingSystemReload;

    public Transaction getLastOperatingSystemReload() {
        return lastOperatingSystemReload;
    }

    public void setLastOperatingSystemReload(Transaction lastOperatingSystemReload) {
        this.lastOperatingSystemReload = lastOperatingSystemReload;
    }

    /**
     * The last transaction a cloud server had performed.
     */
    @ApiProperty
    protected Transaction lastTransaction;

    public Transaction getLastTransaction() {
        return lastTransaction;
    }

    public void setLastTransaction(Transaction lastTransaction) {
        this.lastTransaction = lastTransaction;
    }

    /**
     * A virtual guest's latest network monitoring incident.
     */
    @ApiProperty
    protected Incident latestNetworkMonitorIncident;

    public Incident getLatestNetworkMonitorIncident() {
        return latestNetworkMonitorIncident;
    }

    public void setLatestNetworkMonitorIncident(Incident latestNetworkMonitorIncident) {
        this.latestNetworkMonitorIncident = latestNetworkMonitorIncident;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Boolean localDiskFlag;

    public Boolean getLocalDiskFlag() {
        return localDiskFlag;
    }

    public void setLocalDiskFlag(Boolean localDiskFlag) {
        this.localDiskFlag = localDiskFlag;
    }

    /**
     * Where guest is located within SoftLayer's location hierarchy.
     */
    @ApiProperty
    protected Location location;

    public Location getLocation() {
        return location;
    }

    public void setLocation(Location location) {
        this.location = location;
    }

    /**
     * A flag indicating that the virtual guest is a managed resource.
     */
    @ApiProperty
    protected Boolean managedResourceFlag;

    public Boolean getManagedResourceFlag() {
        return managedResourceFlag;
    }

    public void setManagedResourceFlag(Boolean managedResourceFlag) {
        this.managedResourceFlag = managedResourceFlag;
    }

    /**
     * A guest's metric tracking object.
     */
    @ApiProperty
    protected Object metricTrackingObject;

    public Object getMetricTrackingObject() {
        return metricTrackingObject;
    }

    public void setMetricTrackingObject(Object metricTrackingObject) {
        this.metricTrackingObject = metricTrackingObject;
    }

    /**
     * The metric tracking object id for this guest.
     */
    @ApiProperty
    protected Long metricTrackingObjectId;

    public Long getMetricTrackingObjectId() {
        return metricTrackingObjectId;
    }

    public void setMetricTrackingObjectId(Long metricTrackingObjectId) {
        this.metricTrackingObjectId = metricTrackingObjectId;
    }

    @ApiProperty
    protected List monitoringAgents;

    public List getMonitoringAgents() {
        if (monitoringAgents == null) {
            monitoringAgents = new ArrayList();
        }
        return monitoringAgents;
    }

    @ApiProperty
    protected Robot monitoringRobot;

    public Robot getMonitoringRobot() {
        return monitoringRobot;
    }

    public void setMonitoringRobot(Robot monitoringRobot) {
        this.monitoringRobot = monitoringRobot;
    }

    /**
     * A virtual guest's network monitoring services.
     */
    @ApiProperty
    protected Stratum monitoringServiceComponent;

    public Stratum getMonitoringServiceComponent() {
        return monitoringServiceComponent;
    }

    public void setMonitoringServiceComponent(Stratum monitoringServiceComponent) {
        this.monitoringServiceComponent = monitoringServiceComponent;
    }

    @ApiProperty
    protected Boolean monitoringServiceEligibilityFlag;

    public Boolean getMonitoringServiceEligibilityFlag() {
        return monitoringServiceEligibilityFlag;
    }

    public void setMonitoringServiceEligibilityFlag(Boolean monitoringServiceEligibilityFlag) {
        this.monitoringServiceEligibilityFlag = monitoringServiceEligibilityFlag;
    }

    @ApiProperty
    protected Boolean monitoringServiceFlag;

    public Boolean getMonitoringServiceFlag() {
        return monitoringServiceFlag;
    }

    public void setMonitoringServiceFlag(Boolean monitoringServiceFlag) {
        this.monitoringServiceFlag = monitoringServiceFlag;
    }

    /**
     * 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
     */
    @ApiProperty
    protected List monitoringUserNotification;

    public List getMonitoringUserNotification() {
        if (monitoringUserNotification == null) {
            monitoringUserNotification = new ArrayList();
        }
        return monitoringUserNotification;
    }

    /**
     * A guests's network components.
     */
    @ApiProperty
    protected List networkComponents;

    public List getNetworkComponents() {
        if (networkComponents == null) {
            networkComponents = new ArrayList();
        }
        return networkComponents;
    }

    /**
     * All of a virtual guest's network monitoring incidents.
     */
    @ApiProperty
    protected List networkMonitorIncidents;

    public List getNetworkMonitorIncidents() {
        if (networkMonitorIncidents == null) {
            networkMonitorIncidents = new ArrayList();
        }
        return networkMonitorIncidents;
    }

    /**
     * A guests's network monitors.
     */
    @ApiProperty
    protected List networkMonitors;

    public List getNetworkMonitors() {
        if (networkMonitors == null) {
            networkMonitors = new ArrayList();
        }
        return networkMonitors;
    }

    /**
     * A guest's associated network storage accounts.
     */
    @ApiProperty
    protected List networkStorage;

    public List getNetworkStorage() {
        if (networkStorage == null) {
            networkStorage = new ArrayList();
        }
        return networkStorage;
    }

    /**
     * The network Vlans that a guest's network components are associated with.
     */
    @ApiProperty
    protected List networkVlans;

    public List getNetworkVlans() {
        if (networkVlans == null) {
            networkVlans = new ArrayList();
        }
        return networkVlans;
    }

    /**
     * An open ticket requesting cancellation of this server, if one exists.
     */
    @ApiProperty
    protected Ticket openCancellationTicket;

    public Ticket getOpenCancellationTicket() {
        return openCancellationTicket;
    }

    public void setOpenCancellationTicket(Ticket openCancellationTicket) {
        this.openCancellationTicket = openCancellationTicket;
    }

    /**
     * A guest's operating system.
     */
    @ApiProperty
    protected OperatingSystem operatingSystem;

    public OperatingSystem getOperatingSystem() {
        return operatingSystem;
    }

    public void setOperatingSystem(OperatingSystem operatingSystem) {
        this.operatingSystem = operatingSystem;
    }

    /**
     * A guest's operating system software description.
     */
    @ApiProperty
    protected String operatingSystemReferenceCode;

    public String getOperatingSystemReferenceCode() {
        return operatingSystemReferenceCode;
    }

    public void setOperatingSystemReferenceCode(String operatingSystemReferenceCode) {
        this.operatingSystemReferenceCode = operatingSystemReferenceCode;
    }

    /**
     * The original package id provided with the order for a Cloud Computing Instance.
     */
    @ApiProperty
    protected String orderedPackageId;

    public String getOrderedPackageId() {
        return orderedPackageId;
    }

    public void setOrderedPackageId(String orderedPackageId) {
        this.orderedPackageId = orderedPackageId;
    }

    /**
     * The total private outbound bandwidth for this computing instance for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal outboundPrivateBandwidthUsage;

    public BigDecimal getOutboundPrivateBandwidthUsage() {
        return outboundPrivateBandwidthUsage;
    }

    public void setOutboundPrivateBandwidthUsage(BigDecimal outboundPrivateBandwidthUsage) {
        this.outboundPrivateBandwidthUsage = outboundPrivateBandwidthUsage;
    }

    /**
     * The total public outbound bandwidth for this computing instance for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal outboundPublicBandwidthUsage;

    public BigDecimal getOutboundPublicBandwidthUsage() {
        return outboundPublicBandwidthUsage;
    }

    public void setOutboundPublicBandwidthUsage(BigDecimal outboundPublicBandwidthUsage) {
        this.outboundPublicBandwidthUsage = outboundPublicBandwidthUsage;
    }

    /**
     * Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
     */
    @ApiProperty
    protected Long overBandwidthAllocationFlag;

    public Long getOverBandwidthAllocationFlag() {
        return overBandwidthAllocationFlag;
    }

    public void setOverBandwidthAllocationFlag(Long overBandwidthAllocationFlag) {
        this.overBandwidthAllocationFlag = overBandwidthAllocationFlag;
    }

    /**
     * The current power state of a virtual guest.
     */
    @ApiProperty
    protected State powerState;

    public State getPowerState() {
        return powerState;
    }

    public void setPowerState(State powerState) {
        this.powerState = powerState;
    }

    /**
     * A guest's primary private IP address.
     */
    @ApiProperty
    protected String primaryBackendIpAddress;

    public String getPrimaryBackendIpAddress() {
        return primaryBackendIpAddress;
    }

    public void setPrimaryBackendIpAddress(String primaryBackendIpAddress) {
        this.primaryBackendIpAddress = primaryBackendIpAddress;
    }

    /**
     * A guest's primary backend network component.
     */
    @ApiProperty
    protected com.softlayer.api.service.virtual.guest.network.Component primaryBackendNetworkComponent;

    public com.softlayer.api.service.virtual.guest.network.Component getPrimaryBackendNetworkComponent() {
        return primaryBackendNetworkComponent;
    }

    public void setPrimaryBackendNetworkComponent(com.softlayer.api.service.virtual.guest.network.Component primaryBackendNetworkComponent) {
        this.primaryBackendNetworkComponent = primaryBackendNetworkComponent;
    }

    /**
     * The guest's primary public IP address.
     */
    @ApiProperty
    protected String primaryIpAddress;

    public String getPrimaryIpAddress() {
        return primaryIpAddress;
    }

    public void setPrimaryIpAddress(String primaryIpAddress) {
        this.primaryIpAddress = primaryIpAddress;
    }

    /**
     * A guest's primary public network component.
     */
    @ApiProperty
    protected com.softlayer.api.service.virtual.guest.network.Component primaryNetworkComponent;

    public com.softlayer.api.service.virtual.guest.network.Component getPrimaryNetworkComponent() {
        return primaryNetworkComponent;
    }

    public void setPrimaryNetworkComponent(com.softlayer.api.service.virtual.guest.network.Component primaryNetworkComponent) {
        this.primaryNetworkComponent = primaryNetworkComponent;
    }

    /**
     * Whether the computing instance only has access to the private network.
     */
    @ApiProperty
    protected Boolean privateNetworkOnlyFlag;

    public Boolean getPrivateNetworkOnlyFlag() {
        return privateNetworkOnlyFlag;
    }

    public void setPrivateNetworkOnlyFlag(Boolean privateNetworkOnlyFlag) {
        this.privateNetworkOnlyFlag = privateNetworkOnlyFlag;
    }

    /**
     * Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.
     */
    @ApiProperty
    protected Long projectedOverBandwidthAllocationFlag;

    public Long getProjectedOverBandwidthAllocationFlag() {
        return projectedOverBandwidthAllocationFlag;
    }

    public void setProjectedOverBandwidthAllocationFlag(Long projectedOverBandwidthAllocationFlag) {
        this.projectedOverBandwidthAllocationFlag = projectedOverBandwidthAllocationFlag;
    }

    /**
     * The projected public outbound bandwidth for this computing instance for the current billing cycle.
     */
    @ApiProperty
    protected BigDecimal projectedPublicBandwidthUsage;

    public BigDecimal getProjectedPublicBandwidthUsage() {
        return projectedPublicBandwidthUsage;
    }

    public void setProjectedPublicBandwidthUsage(BigDecimal projectedPublicBandwidthUsage) {
        this.projectedPublicBandwidthUsage = projectedPublicBandwidthUsage;
    }

    /**
     * The date a cloud server was ordered.
     */
    @ApiProperty
    protected GregorianCalendar provisionDate;

    public GregorianCalendar getProvisionDate() {
        return provisionDate;
    }

    public void setProvisionDate(GregorianCalendar provisionDate) {
        this.provisionDate = provisionDate;
    }

    /**
     * Recent events that impact this computing instance.
     */
    @ApiProperty
    protected List recentEvents;

    public List getRecentEvents() {
        if (recentEvents == null) {
            recentEvents = new ArrayList();
        }
        return recentEvents;
    }

    /**
     * The regional group this guest is in.
     */
    @ApiProperty
    protected Regional regionalGroup;

    public Regional getRegionalGroup() {
        return regionalGroup;
    }

    public void setRegionalGroup(Regional regionalGroup) {
        this.regionalGroup = regionalGroup;
    }

    @ApiProperty
    protected Registry regionalInternetRegistry;

    public Registry getRegionalInternetRegistry() {
        return regionalInternetRegistry;
    }

    public void setRegionalInternetRegistry(Registry regionalInternetRegistry) {
        this.regionalInternetRegistry = regionalInternetRegistry;
    }

    /**
     * Collection of scale assets this guest corresponds to.
     */
    @ApiProperty
    protected List scaleAssets;

    public List getScaleAssets() {
        if (scaleAssets == null) {
            scaleAssets = new ArrayList();
        }
        return scaleAssets;
    }

    /**
     * The scale member for this guest, if applicable.
     */
    @ApiProperty
    protected com.softlayer.api.service.scale.member.virtual.Guest scaleMember;

    public com.softlayer.api.service.scale.member.virtual.Guest getScaleMember() {
        return scaleMember;
    }

    public void setScaleMember(com.softlayer.api.service.scale.member.virtual.Guest scaleMember) {
        this.scaleMember = scaleMember;
    }

    /**
     * Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.
     */
    @ApiProperty
    protected Boolean scaledFlag;

    public Boolean getScaledFlag() {
        return scaledFlag;
    }

    public void setScaledFlag(Boolean scaledFlag) {
        this.scaledFlag = scaledFlag;
    }

    /**
     * A guest's vulnerability scan requests.
     */
    @ApiProperty
    protected List securityScanRequests;

    public List getSecurityScanRequests() {
        if (securityScanRequests == null) {
            securityScanRequests = new ArrayList();
        }
        return securityScanRequests;
    }

    /**
     * The server room that a guest is located at. There may be more than one server room for every data center.
     */
    @ApiProperty
    protected Location serverRoom;

    public Location getServerRoom() {
        return serverRoom;
    }

    public void setServerRoom(Location serverRoom) {
        this.serverRoom = serverRoom;
    }

    /**
     * A guest's installed software.
     */
    @ApiProperty
    protected List softwareComponents;

    public List getSoftwareComponents() {
        if (softwareComponents == null) {
            softwareComponents = new ArrayList();
        }
        return softwareComponents;
    }

    /**
     * SSH keys to be installed on the server during provisioning or an OS reload.
     */
    @ApiProperty
    protected List sshKeys;

    public List getSshKeys() {
        if (sshKeys == null) {
            sshKeys = new ArrayList();
        }
        return sshKeys;
    }

    /**
     * A computing instance's status.
     */
    @ApiProperty
    protected Status status;

    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    @ApiProperty
    protected List tagReferences;

    public List getTagReferences() {
        if (tagReferences == null) {
            tagReferences = new ArrayList();
        }
        return tagReferences;
    }

    /**
     * A computing instance's associated upgrade request object if any.
     */
    @ApiProperty
    protected Request upgradeRequest;

    public Request getUpgradeRequest() {
        return upgradeRequest;
    }

    public void setUpgradeRequest(Request upgradeRequest) {
        this.upgradeRequest = upgradeRequest;
    }

    /**
     * A base64 encoded string containing custom user data for a Cloud Computing Instance order.
     */
    @ApiProperty
    protected List userData;

    public List getUserData() {
        if (userData == null) {
            userData = new ArrayList();
        }
        return userData;
    }

    /**
     * A list of users that have access to this computing instance.
     */
    @ApiProperty
    protected List users;

    public List getUsers() {
        if (users == null) {
            users = new ArrayList();
        }
        return users;
    }

    /**
     * The name of the bandwidth allotment that a hardware belongs too.
     */
    @ApiProperty
    protected Allotment virtualRack;

    public Allotment getVirtualRack() {
        return virtualRack;
    }

    public void setVirtualRack(Allotment virtualRack) {
        this.virtualRack = virtualRack;
    }

    /**
     * The id of the bandwidth allotment that a computing instance belongs too.
     */
    @ApiProperty
    protected Long virtualRackId;

    public Long getVirtualRackId() {
        return virtualRackId;
    }

    public void setVirtualRackId(Long virtualRackId) {
        this.virtualRackId = virtualRackId;
    }

    /**
     * The name of the bandwidth allotment that a computing instance belongs too.
     */
    @ApiProperty
    protected String virtualRackName;

    public String getVirtualRackName() {
        return virtualRackName;
    }

    public void setVirtualRackName(String virtualRackName) {
        this.virtualRackName = virtualRackName;
    }

    /**
     * A computing instance's associated [[SoftLayer_Account|account]] id 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long accountId;

    public Long getAccountId() {
        return accountId;
    }

    public void setAccountId(Long accountId) {
        accountIdSpecified = true;
        this.accountId = accountId;
    }

    protected boolean accountIdSpecified;

    public boolean isAccountIdSpecified() {
        return accountIdSpecified;
    }

    public void unsetAccountId() {
        accountId = null;
        accountIdSpecified = false;
    }

    /**
     * The date a virtual computing instance was created. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar createDate;

    public GregorianCalendar getCreateDate() {
        return createDate;
    }

    public void setCreateDate(GregorianCalendar createDate) {
        createDateSpecified = true;
        this.createDate = createDate;
    }

    protected boolean createDateSpecified;

    public boolean isCreateDateSpecified() {
        return createDateSpecified;
    }

    public void unsetCreateDate() {
        createDate = null;
        createDateSpecified = false;
    }

    /**
     * When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean dedicatedAccountHostOnlyFlag;

    public Boolean getDedicatedAccountHostOnlyFlag() {
        return dedicatedAccountHostOnlyFlag;
    }

    public void setDedicatedAccountHostOnlyFlag(Boolean dedicatedAccountHostOnlyFlag) {
        dedicatedAccountHostOnlyFlagSpecified = true;
        this.dedicatedAccountHostOnlyFlag = dedicatedAccountHostOnlyFlag;
    }

    protected boolean dedicatedAccountHostOnlyFlagSpecified;

    public boolean isDedicatedAccountHostOnlyFlagSpecified() {
        return dedicatedAccountHostOnlyFlagSpecified;
    }

    public void unsetDedicatedAccountHostOnlyFlag() {
        dedicatedAccountHostOnlyFlag = null;
        dedicatedAccountHostOnlyFlagSpecified = false;
    }

    /**
     * A computing instance's domain name 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String domain;

    public String getDomain() {
        return domain;
    }

    public void setDomain(String domain) {
        domainSpecified = true;
        this.domain = domain;
    }

    protected boolean domainSpecified;

    public boolean isDomainSpecified() {
        return domainSpecified;
    }

    public void unsetDomain() {
        domain = null;
        domainSpecified = false;
    }

    /**
     * A name reflecting the hostname and domain of the computing instance.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String fullyQualifiedDomainName;

    public String getFullyQualifiedDomainName() {
        return fullyQualifiedDomainName;
    }

    public void setFullyQualifiedDomainName(String fullyQualifiedDomainName) {
        fullyQualifiedDomainNameSpecified = true;
        this.fullyQualifiedDomainName = fullyQualifiedDomainName;
    }

    protected boolean fullyQualifiedDomainNameSpecified;

    public boolean isFullyQualifiedDomainNameSpecified() {
        return fullyQualifiedDomainNameSpecified;
    }

    public void unsetFullyQualifiedDomainName() {
        fullyQualifiedDomainName = null;
        fullyQualifiedDomainNameSpecified = false;
    }

    /**
     * A virtual computing instance's hostname 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String hostname;

    public String getHostname() {
        return hostname;
    }

    public void setHostname(String hostname) {
        hostnameSpecified = true;
        this.hostname = hostname;
    }

    protected boolean hostnameSpecified;

    public boolean isHostnameSpecified() {
        return hostnameSpecified;
    }

    public void unsetHostname() {
        hostname = null;
        hostnameSpecified = false;
    }

    /**
     * Unique ID for a computing instance. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Long lastPowerStateId;

    public Long getLastPowerStateId() {
        return lastPowerStateId;
    }

    public void setLastPowerStateId(Long lastPowerStateId) {
        lastPowerStateIdSpecified = true;
        this.lastPowerStateId = lastPowerStateId;
    }

    protected boolean lastPowerStateIdSpecified;

    public boolean isLastPowerStateIdSpecified() {
        return lastPowerStateIdSpecified;
    }

    public void unsetLastPowerStateId() {
        lastPowerStateId = null;
        lastPowerStateIdSpecified = false;
    }

    /**
     * The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar lastVerifiedDate;

    public GregorianCalendar getLastVerifiedDate() {
        return lastVerifiedDate;
    }

    public void setLastVerifiedDate(GregorianCalendar lastVerifiedDate) {
        lastVerifiedDateSpecified = true;
        this.lastVerifiedDate = lastVerifiedDate;
    }

    protected boolean lastVerifiedDateSpecified;

    public boolean isLastVerifiedDateSpecified() {
        return lastVerifiedDateSpecified;
    }

    public void unsetLastVerifiedDate() {
        lastVerifiedDate = null;
        lastVerifiedDateSpecified = false;
    }

    /**
     * The maximum amount of CPU resources a computing instance may utilize. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long maxCpu;

    public Long getMaxCpu() {
        return maxCpu;
    }

    public void setMaxCpu(Long maxCpu) {
        maxCpuSpecified = true;
        this.maxCpu = maxCpu;
    }

    protected boolean maxCpuSpecified;

    public boolean isMaxCpuSpecified() {
        return maxCpuSpecified;
    }

    public void unsetMaxCpu() {
        maxCpu = null;
        maxCpuSpecified = false;
    }

    /**
     * The unit of the maximum amount of CPU resources a computing instance may utilize. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String maxCpuUnits;

    public String getMaxCpuUnits() {
        return maxCpuUnits;
    }

    public void setMaxCpuUnits(String maxCpuUnits) {
        maxCpuUnitsSpecified = true;
        this.maxCpuUnits = maxCpuUnits;
    }

    protected boolean maxCpuUnitsSpecified;

    public boolean isMaxCpuUnitsSpecified() {
        return maxCpuUnitsSpecified;
    }

    public void unsetMaxCpuUnits() {
        maxCpuUnits = null;
        maxCpuUnitsSpecified = false;
    }

    /**
     * The maximum amount of memory a computing instance may utilize. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long maxMemory;

    public Long getMaxMemory() {
        return maxMemory;
    }

    public void setMaxMemory(Long maxMemory) {
        maxMemorySpecified = true;
        this.maxMemory = maxMemory;
    }

    protected boolean maxMemorySpecified;

    public boolean isMaxMemorySpecified() {
        return maxMemorySpecified;
    }

    public void unsetMaxMemory() {
        maxMemory = null;
        maxMemorySpecified = false;
    }

    /**
     * The date of the most recent metric tracking poll performed. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar metricPollDate;

    public GregorianCalendar getMetricPollDate() {
        return metricPollDate;
    }

    public void setMetricPollDate(GregorianCalendar metricPollDate) {
        metricPollDateSpecified = true;
        this.metricPollDate = metricPollDate;
    }

    protected boolean metricPollDateSpecified;

    public boolean isMetricPollDateSpecified() {
        return metricPollDateSpecified;
    }

    public void unsetMetricPollDate() {
        metricPollDate = null;
        metricPollDateSpecified = false;
    }

    /**
     * The date a virtual computing instance was last modified. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected GregorianCalendar modifyDate;

    public GregorianCalendar getModifyDate() {
        return modifyDate;
    }

    public void setModifyDate(GregorianCalendar modifyDate) {
        modifyDateSpecified = true;
        this.modifyDate = modifyDate;
    }

    protected boolean modifyDateSpecified;

    public boolean isModifyDateSpecified() {
        return modifyDateSpecified;
    }

    public void unsetModifyDate() {
        modifyDate = null;
        modifyDateSpecified = false;
    }

    /**
     * A note of up to 1,000 characters about a virtual server. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String notes;

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        notesSpecified = true;
        this.notes = notes;
    }

    protected boolean notesSpecified;

    public boolean isNotesSpecified() {
        return notesSpecified;
    }

    public void unsetNotes() {
        notes = null;
        notesSpecified = false;
    }

    /**
     * URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions' postInstallScriptUri. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String postInstallScriptUri;

    public String getPostInstallScriptUri() {
        return postInstallScriptUri;
    }

    public void setPostInstallScriptUri(String postInstallScriptUri) {
        postInstallScriptUriSpecified = true;
        this.postInstallScriptUri = postInstallScriptUri;
    }

    protected boolean postInstallScriptUriSpecified;

    public boolean isPostInstallScriptUriSpecified() {
        return postInstallScriptUriSpecified;
    }

    public void unsetPostInstallScriptUri() {
        postInstallScriptUri = null;
        postInstallScriptUriSpecified = false;
    }

    /**
     * The number of CPUs available to a computing instance upon startup. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long startCpus;

    public Long getStartCpus() {
        return startCpus;
    }

    public void setStartCpus(Long startCpus) {
        startCpusSpecified = true;
        this.startCpus = startCpus;
    }

    protected boolean startCpusSpecified;

    public boolean isStartCpusSpecified() {
        return startCpusSpecified;
    }

    public void unsetStartCpus() {
        startCpus = null;
        startCpusSpecified = false;
    }

    /**
     * A computing instances [[SoftLayer_Virtual_Guest_Status|status]] ID 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long statusId;

    public Long getStatusId() {
        return statusId;
    }

    public void setStatusId(Long statusId) {
        statusIdSpecified = true;
        this.statusId = statusId;
    }

    protected boolean statusIdSpecified;

    public boolean isStatusIdSpecified() {
        return statusIdSpecified;
    }

    public void unsetStatusId() {
        statusId = null;
        statusIdSpecified = false;
    }

    /**
     * Extra options needed for [[SoftLayer_Virtual_Guest/createObject|createObject]] and [[SoftLayer_Virtual_Guest/createObjects|createObjects]]. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected SupplementalCreateObjectOptions supplementalCreateObjectOptions;

    public SupplementalCreateObjectOptions getSupplementalCreateObjectOptions() {
        return supplementalCreateObjectOptions;
    }

    public void setSupplementalCreateObjectOptions(SupplementalCreateObjectOptions supplementalCreateObjectOptions) {
        supplementalCreateObjectOptionsSpecified = true;
        this.supplementalCreateObjectOptions = supplementalCreateObjectOptions;
    }

    protected boolean supplementalCreateObjectOptionsSpecified;

    public boolean isSupplementalCreateObjectOptionsSpecified() {
        return supplementalCreateObjectOptionsSpecified;
    }

    public void unsetSupplementalCreateObjectOptions() {
        supplementalCreateObjectOptions = null;
        supplementalCreateObjectOptionsSpecified = false;
    }

    /**
     * Unique ID for a computing instance's record on a virtualization platform. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String uuid;

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        uuidSpecified = true;
        this.uuid = uuid;
    }

    protected boolean uuidSpecified;

    public boolean isUuidSpecified() {
        return uuidSpecified;
    }

    public void unsetUuid() {
        uuid = null;
        uuidSpecified = false;
    }

    /**
     * A count of a virtual guest's currently active network monitoring incidents.
     */
    @ApiProperty
    protected Long activeNetworkMonitorIncidentCount;

    public Long getActiveNetworkMonitorIncidentCount() {
        return activeNetworkMonitorIncidentCount;
    }

    public void setActiveNetworkMonitorIncidentCount(Long activeNetworkMonitorIncidentCount) {
        this.activeNetworkMonitorIncidentCount = activeNetworkMonitorIncidentCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long activeTicketCount;

    public Long getActiveTicketCount() {
        return activeTicketCount;
    }

    public void setActiveTicketCount(Long activeTicketCount) {
        this.activeTicketCount = activeTicketCount;
    }

    /**
     * A count of any active transaction(s) that are currently running for the server (example: os reload).
     */
    @ApiProperty
    protected Long activeTransactionCount;

    public Long getActiveTransactionCount() {
        return activeTransactionCount;
    }

    public void setActiveTransactionCount(Long activeTransactionCount) {
        this.activeTransactionCount = activeTransactionCount;
    }

    /**
     * A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
     */
    @ApiProperty
    protected Long allowedNetworkStorageCount;

    public Long getAllowedNetworkStorageCount() {
        return allowedNetworkStorageCount;
    }

    public void setAllowedNetworkStorageCount(Long allowedNetworkStorageCount) {
        this.allowedNetworkStorageCount = allowedNetworkStorageCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long attributeCount;

    public Long getAttributeCount() {
        return attributeCount;
    }

    public void setAttributeCount(Long attributeCount) {
        this.attributeCount = attributeCount;
    }

    /**
     * A count of an object that stores the maximum level for the monitoring query types and response types.
     */
    @ApiProperty
    protected Long availableMonitoringCount;

    public Long getAvailableMonitoringCount() {
        return availableMonitoringCount;
    }

    public void setAvailableMonitoringCount(Long availableMonitoringCount) {
        this.availableMonitoringCount = availableMonitoringCount;
    }

    /**
     * A count of a guests's backend network components.
     */
    @ApiProperty
    protected Long backendNetworkComponentCount;

    public Long getBackendNetworkComponentCount() {
        return backendNetworkComponentCount;
    }

    public void setBackendNetworkComponentCount(Long backendNetworkComponentCount) {
        this.backendNetworkComponentCount = backendNetworkComponentCount;
    }

    /**
     * A count of a guest's backend or private router.
     */
    @ApiProperty
    protected Long backendRouterCount;

    public Long getBackendRouterCount() {
        return backendRouterCount;
    }

    public void setBackendRouterCount(Long backendRouterCount) {
        this.backendRouterCount = backendRouterCount;
    }

    /**
     * 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.
     */
    @ApiProperty
    protected Long billingCycleBandwidthUsageCount;

    public Long getBillingCycleBandwidthUsageCount() {
        return billingCycleBandwidthUsageCount;
    }

    public void setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount) {
        this.billingCycleBandwidthUsageCount = billingCycleBandwidthUsageCount;
    }

    /**
     * A count of a computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.
     */
    @ApiProperty
    protected Long blockDeviceCount;

    public Long getBlockDeviceCount() {
        return blockDeviceCount;
    }

    public void setBlockDeviceCount(Long blockDeviceCount) {
        this.blockDeviceCount = blockDeviceCount;
    }

    /**
     * A count of a guest's associated EVault network storage service account.
     */
    @ApiProperty
    protected Long evaultNetworkStorageCount;

    public Long getEvaultNetworkStorageCount() {
        return evaultNetworkStorageCount;
    }

    public void setEvaultNetworkStorageCount(Long evaultNetworkStorageCount) {
        this.evaultNetworkStorageCount = evaultNetworkStorageCount;
    }

    /**
     * A count of a guest's frontend network components.
     */
    @ApiProperty
    protected Long frontendNetworkComponentCount;

    public Long getFrontendNetworkComponentCount() {
        return frontendNetworkComponentCount;
    }

    public void setFrontendNetworkComponentCount(Long frontendNetworkComponentCount) {
        this.frontendNetworkComponentCount = frontendNetworkComponentCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long internalTagReferenceCount;

    public Long getInternalTagReferenceCount() {
        return internalTagReferenceCount;
    }

    public void setInternalTagReferenceCount(Long internalTagReferenceCount) {
        this.internalTagReferenceCount = internalTagReferenceCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long monitoringAgentCount;

    public Long getMonitoringAgentCount() {
        return monitoringAgentCount;
    }

    public void setMonitoringAgentCount(Long monitoringAgentCount) {
        this.monitoringAgentCount = monitoringAgentCount;
    }

    /**
     * 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
     */
    @ApiProperty
    protected Long monitoringUserNotificationCount;

    public Long getMonitoringUserNotificationCount() {
        return monitoringUserNotificationCount;
    }

    public void setMonitoringUserNotificationCount(Long monitoringUserNotificationCount) {
        this.monitoringUserNotificationCount = monitoringUserNotificationCount;
    }

    /**
     * A count of a guests's network components.
     */
    @ApiProperty
    protected Long networkComponentCount;

    public Long getNetworkComponentCount() {
        return networkComponentCount;
    }

    public void setNetworkComponentCount(Long networkComponentCount) {
        this.networkComponentCount = networkComponentCount;
    }

    /**
     * A count of a guests's network monitors.
     */
    @ApiProperty
    protected Long networkMonitorCount;

    public Long getNetworkMonitorCount() {
        return networkMonitorCount;
    }

    public void setNetworkMonitorCount(Long networkMonitorCount) {
        this.networkMonitorCount = networkMonitorCount;
    }

    /**
     * A count of all of a virtual guest's network monitoring incidents.
     */
    @ApiProperty
    protected Long networkMonitorIncidentCount;

    public Long getNetworkMonitorIncidentCount() {
        return networkMonitorIncidentCount;
    }

    public void setNetworkMonitorIncidentCount(Long networkMonitorIncidentCount) {
        this.networkMonitorIncidentCount = networkMonitorIncidentCount;
    }

    /**
     * A count of a guest's associated network storage accounts.
     */
    @ApiProperty
    protected Long networkStorageCount;

    public Long getNetworkStorageCount() {
        return networkStorageCount;
    }

    public void setNetworkStorageCount(Long networkStorageCount) {
        this.networkStorageCount = networkStorageCount;
    }

    /**
     * A count of the network Vlans that a guest's network components are associated with.
     */
    @ApiProperty
    protected Long networkVlanCount;

    public Long getNetworkVlanCount() {
        return networkVlanCount;
    }

    public void setNetworkVlanCount(Long networkVlanCount) {
        this.networkVlanCount = networkVlanCount;
    }

    /**
     * A count of recent events that impact this computing instance.
     */
    @ApiProperty
    protected Long recentEventCount;

    public Long getRecentEventCount() {
        return recentEventCount;
    }

    public void setRecentEventCount(Long recentEventCount) {
        this.recentEventCount = recentEventCount;
    }

    /**
     * A count of collection of scale assets this guest corresponds to.
     */
    @ApiProperty
    protected Long scaleAssetCount;

    public Long getScaleAssetCount() {
        return scaleAssetCount;
    }

    public void setScaleAssetCount(Long scaleAssetCount) {
        this.scaleAssetCount = scaleAssetCount;
    }

    /**
     * A count of a guest's vulnerability scan requests.
     */
    @ApiProperty
    protected Long securityScanRequestCount;

    public Long getSecurityScanRequestCount() {
        return securityScanRequestCount;
    }

    public void setSecurityScanRequestCount(Long securityScanRequestCount) {
        this.securityScanRequestCount = securityScanRequestCount;
    }

    /**
     * A count of a guest's installed software.
     */
    @ApiProperty
    protected Long softwareComponentCount;

    public Long getSoftwareComponentCount() {
        return softwareComponentCount;
    }

    public void setSoftwareComponentCount(Long softwareComponentCount) {
        this.softwareComponentCount = softwareComponentCount;
    }

    /**
     * A count of sSH keys to be installed on the server during provisioning or an OS reload.
     */
    @ApiProperty
    protected Long sshKeyCount;

    public Long getSshKeyCount() {
        return sshKeyCount;
    }

    public void setSshKeyCount(Long sshKeyCount) {
        this.sshKeyCount = sshKeyCount;
    }

    /**
     * A count of 
     */
    @ApiProperty
    protected Long tagReferenceCount;

    public Long getTagReferenceCount() {
        return tagReferenceCount;
    }

    public void setTagReferenceCount(Long tagReferenceCount) {
        this.tagReferenceCount = tagReferenceCount;
    }

    /**
     * A count of a list of users that have access to this computing instance.
     */
    @ApiProperty
    protected Long userCount;

    public Long getUserCount() {
        return userCount;
    }

    public void setUserCount(Long userCount) {
        this.userCount = userCount;
    }

    /**
     * A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order.
     */
    @ApiProperty
    protected Long userDataCount;

    public Long getUserDataCount() {
        return userDataCount;
    }

    public void setUserDataCount(Long userDataCount) {
        this.userDataCount = userDataCount;
    }

    public Service asService(ApiClient client) {
        if (id != null) {
            return service(client, id);
        } else {
            return service(client, globalIdentifier);
        }
    }

    public static Service service(ApiClient client) {
        return client.createService(Service.class, null);
    }

    public static Service service(ApiClient client, Long id) {
        return client.createService(Service.class, id == null ? null : id.toString());
    }

    public static Service service(ApiClient client, String globalIdentifier) {
        return client.createService(Service.class, globalIdentifier);
    }

    /**
     * The virtual guest service provides a common interface to any virtualization platform supported by SoftLayer. The interaction with various third party APIs is not needed when implementing this service to administer your guests. The SoftLayer_Virtual_Guest service also controls individual CloudLayer Computing Instances purchased from SoftLayer in a way that is analogous to the [[SoftLayer_Hardware_Server]] service's control over physical hardware purchased form SoftLayer. 
     *
     * @see SoftLayer_Virtual_Guest
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Virtual_Guest")
    public static interface Service extends com.softlayer.api.Service {

        public ServiceAsync asAsync();
        public Mask withNewMask();
        public Mask withMask();
        public void setMask(Mask mask);

        /**
         * Activate the private network port
         *
         * @see SoftLayer_Virtual_Guest::activatePrivatePort
         */
        @ApiMethod(instanceRequired = true)
        public Boolean activatePrivatePort();

        /**
         * Activate the public network port
         *
         * @see SoftLayer_Virtual_Guest::activatePublicPort
         */
        @ApiMethod(instanceRequired = true)
        public Boolean activatePublicPort();

        /**
         * This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control. 
         *
         * @see SoftLayer_Virtual_Guest::allowAccessToNetworkStorage
         */
        @ApiMethod(instanceRequired = true)
        public Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject);

        /**
         * This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control. 
         *
         * @see SoftLayer_Virtual_Guest::allowAccessToNetworkStorageList
         */
        @ApiMethod(instanceRequired = true)
        public Boolean allowAccessToNetworkStorageList(List networkStorageTemplateObjects);

        /**
         * Creates a transaction to attach a guest's disk image. If the disk image is already attached it will be ignored. 

         * 

         * WARNING: SoftLayer_Virtual_Guest::checkHostDiskAvailability should be called before this method. If the SoftLayer_Virtual_Guest::checkHostDiskAvailability method is not called before this method, the guest migration will happen automatically. 
         *
         * @see SoftLayer_Virtual_Guest::attachDiskImage
         */
        @ApiMethod(instanceRequired = true)
        public Transaction attachDiskImage(Long imageId);

        /**
         * Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action. 
         *
         * @see SoftLayer_Virtual_Guest::cancelIsolationForDestructiveAction
         */
        @ApiMethod(instanceRequired = true)
        public Void cancelIsolationForDestructiveAction();

        /**
         * Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter. Returns the image template group containing the disk image. 
         *
         * @see SoftLayer_Virtual_Guest::captureImage
         */
        @ApiMethod(instanceRequired = true)
        public Group captureImage(Template captureTemplate);

        /**
         * Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume. 
         *
         * @see SoftLayer_Virtual_Guest::checkHostDiskAvailability
         */
        @ApiMethod(instanceRequired = true)
        public Boolean checkHostDiskAvailability(Long diskCapacity);

        /**
         * Returns monitoring alarm detailed history 
         *
         * @see SoftLayer_Virtual_Guest::closeAlarm
         */
        @ApiMethod(instanceRequired = true)
        public Boolean closeAlarm(String alarmId);

        /**
         * Creates a transaction to configure the guest's metadata disk. If the guest has user data associated with it, the transaction will create a small virtual drive and write the metadata to a file on the drive; if the drive already exists, the metadata will be rewritten. If the guest has no user data associated with it, the transaction will remove the virtual drive if it exists. 

         * 

         * WARNING: The transaction created by this service will shut down the guest while the metadata disk is configured. The guest will be turned back on once this process is complete. 
         *
         * @see SoftLayer_Virtual_Guest::configureMetadataDisk
         */
        @ApiMethod(instanceRequired = true)
        public Transaction configureMetadataDisk();

        /**
         * Create a transaction to archive a computing instance's block devices
         *
         * @see SoftLayer_Virtual_Guest::createArchiveTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Transaction createArchiveTransaction(String groupName, List blockDevices, String note);

        /**
         * 

         *  

         * createObject() enables the creation of computing instances on an account. This 

         * method is a simplified alternative to interacting with the ordering system directly. 

         * 

         * 

         * In order to create a computing instance, a template object must be sent in with a few required 

         * values. 

         * 

         * 

         * When this method returns an order will have been placed for a computing instance of the specified configuration. 

         * 

         * 

         * To determine when the instance is available you can poll the instance via [[SoftLayer_Virtual_Guest/getObject|getObject]], with an [[Extended-Object-Masks|object mask]] requesting the provisionDate relational property. When provisionDate is not null, the instance will be ready. 

         * 

         * 

         * Warning: Computing instances created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Virtual_Guest/generateOrderTemplate|generateOrderTemplate]]. 

         * 

         * 

         * Input - [[SoftLayer_Virtual_Guest (type)|SoftLayer_Virtual_Guest]] 

         * 
 

         *     
hostname 

         *         
Hostname for the computing instance.
 

         *             
Required
 

         *             
Type - string
 

         *         
 

         *         
 

         *     
 

         *     
domain 

         *         
Domain for the computing instance.
 

         *             
Required
 

         *             
Type - string
 

         *         
 

         *         
 

         *     
 

         *     
startCpus 

         *         
The number of CPU cores to allocate.
 

         *             
Required
 

         *             
Type - int
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *         
 

         *     
 

         *     
maxMemory 

         *         
The amount of memory to allocate in megabytes.
 

         *             
Required
 

         *             
Type - int
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *         
 

         *     
 

         *     
datacenter.name 

         *         
Specifies which datacenter the instance is to be provisioned in.
 

         *             
Required
 

         *             
Type - string
 

         *             
The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *         { 

         *     "datacenter": { 

         *         "name": "dal05" 

         *     } 

         * } 

         *         
 

         *     
 

         *     
hourlyBillingFlag 

         *         
Specifies the billing type for the instance.
 

         *             
Required
 

         *             
Type - boolean
 

         *             
When true the computing instance will be billed on hourly usage, otherwise it will be billed on a monthly basis.
 

         *         
 

         *         
 

         *     
 

         *     
localDiskFlag 

         *         
Specifies the disk type for the instance.
 

         *             
Required
 

         *             
Type - boolean
 

         *             
When true the disks for the computing instance will be provisioned on the host which it runs, otherwise SAN disks will be provisioned.
 

         *         
 

         *         
 

         *     
 

         *     
dedicatedAccountHostOnlyFlag 

         *         
Specifies whether or not the instance must only run on hosts with instances from the same account
 

         *             
Optional
 

         *             
Type - boolean
 

         *             
Default - false
 

         *             
When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
 

         *         
 

         *         
 

         *     
 

         *     
operatingSystemReferenceCode 

         *         
An identifier for the operating system to provision the computing instance with.
 

         *             
Conditionally required - Disallowed when blockDeviceTemplateGroup.globalIdentifier is provided, as the template will specify the operating system.
 

         *             
Type - string
 

         *             
Notice - Some operating systems are charged based on the value specified in startCpus. The price which is used can be determined by calling [[SoftLayer_Virtual_Guest/generateOrderTemplate|generateOrderTemplate]] with your desired device specifications.
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *         
 

         *     
 

         *     
blockDeviceTemplateGroup.globalIdentifier 

         *         
A global identifier for the template to be used to provision the computing instance.
 

         *             
Conditionally required - Disallowed when operatingSystemReferenceCode is provided, as the template will specify the operating system.
 

         *             
Type - string
 

         *             
Notice - Some operating systems are charged based on the value specified in startCpus. The price which is used can be determined by calling [[SoftLayer_Virtual_Guest/generateOrderTemplate|generateOrderTemplate]] with your desired device specifications.
 

         *             
Both public and non-public images may be specified.
 

         *             
A list of public images may be obtained via a request to [[SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages|getPublicImages]].
 

         *             
A list of non-public images, images owned by an account or specifically shared with an account, may be obtained via a request to [[SoftLayer_Account/getBlockDeviceTemplateGroups|getBlockDeviceTemplateGroups]].
 

         *         
 

         *         { 

         *     "blockDeviceTemplateGroup": { 

         *         "globalIdentifier": "07beadaa-1e11-476e-a188-3f7795feb9fb" 

         *     } 

         * } 

         *         
 

         *     
 

         *     
networkComponents.maxSpeed 

         *         
Specifies the connection speed for the instance's network components.
 

         *             
Optional
 

         *             
Type - int
 

         *             
Default - 10
 

         *             
Description - The networkComponents property is an array with a single [[SoftLayer_Virtual_Guest_Network_Component (type)|network component]] structure. The maxSpeed property must be set to specify the network uplink speed, in megabits per second, of the computing instance.
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *             { 

         *     "networkComponents": [ 

         *         { 

         *             "maxSpeed": 1000 

         *         } 

         *     ] 

         * } 

         *         
 

         *     
 

         *     
privateNetworkOnlyFlag 

         *         
Specifies whether or not the instance only has access to the private network
 

         *             
Optional
 

         *             
Type - boolean
 

         *             
Default - false
 

         *             
When true this flag specifies that a compute instance is to only have access to the private network.
 

         *         
 

         *         
 

         *     
 

         *     
primaryNetworkComponent.networkVlan.id 

         *         
Specifies the network vlan which is to be used for the frontend interface of the computing instance.
 

         *             
Optional
 

         *             
Type - int
 

         *             
Description - The primaryNetworkComponent property is a [[SoftLayer_Virtual_Guest_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the computing instance.
 

         *         
 

         *         { 

         *     "primaryNetworkComponent": { 

         *         "networkVlan": { 

         *             "id": 1 

         *         } 

         *     } 

         * } 

         *         
 

         *     
 

         *     
primaryBackendNetworkComponent.networkVlan.id 

         *         
Specifies the network vlan which is to be used for the backend interface of the computing instance.
 

         *             
Optional
 

         *             
Type - int
 

         *             
Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Virtual_Guest_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the computing instance.
 

         *         
 

         *         { 

         *     "primaryBackendNetworkComponent": { 

         *         "networkVlan": { 

         *             "id": 2 

         *         } 

         *     } 

         * } 

         *         
 

         *     
 

         *     
blockDevices 

         *         
Block device and disk image settings for the computing instance
 

         *             
Optional
 

         *             
Type - array of [[SoftLayer_Virtual_Guest_Block_Device (type)|SoftLayer_Virtual_Guest_Block_Device]
 

         *             
Default - The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template.
 

         *             
Description - The blockDevices property is an array of [[SoftLayer_Virtual_Guest_Block_Device (type)|block device]] structures. 

         *             
Each block device must specify the device property along with the diskImage property, which is a [[SoftLayer_Virtual_Disk_Image (type)|disk image]] structure with the capacity property set.
 

         *             
The device number '1' is reserved for the SWAP disk attached to the computing instance.
 

         *             
See [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] for available options.
 

         *         
 

         *         { 

         *     "blockDevices": [ 

         *         { 

         *             "device": "0", 

         *             "diskImage": { 

         *                 "capacity": 100 

         *             } 

         *         } 

         *     ], 

         *     "localDiskFlag": true 

         * } 

         *         
 

         *     
 

         *     
userData.value 

         *         
Arbitrary data to be made available to the computing instance.
 

         *             
Optional
 

         *             
Type - string
 

         *             
Description - The userData property is an array with a single [[SoftLayer_Virtual_Guest_Attribute (type)|attribute]] structure with the value property set to an arbitrary value.
 

         *             
This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the computing instance. This is primarily useful for providing data to software that may be on the instance and configured to execute upon first boot.
 

         *         
 

         *         { 

         *     "userData": [ 

         *         { 

         *             "value": "someValue" 

         *         } 

         *     ] 

         * } 

         *         
 

         *     
 

         *     
sshKeys 

         *         
SSH keys to install on the computing instance upon provisioning.
 

         *             
Optional
 

         *             
Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]
 

         *             
Description - The sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property set to the value of an existing SSH key.
 

         *             
To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.
 

         *             
To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service. 

         *         
 

         *         { 

         *     "sshKeys": [ 

         *         { 

         *             "id": 123 

         *         } 

         *     ] 

         * } 

         *         
 

         *     
 

         *     
postInstallScriptUri 

         *         
Specifies the uri location of the script to be downloaded and run after installation is complete.
 

         *             
Optional
 

         *             
Type - string
 

         *         
 

         *         
 

         *     
 

         * 
 

         * 

         * 

         * 
REST Example
 

         * curl -X POST -d '{ 

         *  "parameters":[ 

         *      { 

         *          "hostname": "host1", 

         *          "domain": "example.com", 

         *          "startCpus": 1, 

         *          "maxMemory": 1024, 

         *          "hourlyBillingFlag": true, 

         *          "localDiskFlag": true, 

         *          "operatingSystemReferenceCode": "UBUNTU_LATEST" 

         *      } 

         *  ] 

         * }' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest.json 

         *  

         * HTTP/1.1 201 Created 

         * Location: https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/1301396/getObject 

         * 

         * 

         * { 

         *     "accountId": 232298, 

         *     "createDate": "2012-11-30T16:28:17-06:00", 

         *     "dedicatedAccountHostOnlyFlag": false, 

         *     "domain": "example.com", 

         *     "hostname": "host1", 

         *     "id": 1301396, 

         *     "lastPowerStateId": null, 

         *     "lastVerifiedDate": null, 

         *     "maxCpu": 1, 

         *     "maxCpuUnits": "CORE", 

         *     "maxMemory": 1024, 

         *     "metricPollDate": null, 

         *     "modifyDate": null, 

         *     "privateNetworkOnlyFlag": false, 

         *     "startCpus": 1, 

         *     "statusId": 1001, 

         *     "globalIdentifier": "2d203774-0ee1-49f5-9599-6ef67358dd31" 

         * } 

         *  
         *
         * @see SoftLayer_Virtual_Guest::createObject
         */
        @ApiMethod
        public Guest createObject(Guest templateObject);

        /**
         * 

         * createObjects() enables the creation of multiple computing instances on an account in a single call. This 

         * method is a simplified alternative to interacting with the ordering system directly. 

         * 

         * 

         * In order to create a computing instance a set of template objects must be sent in with a few required 

         * values. 

         * 

         * 

         * Warning: Computing instances created via this method will incur charges on your account. 

         * 

         * 

         * See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of each template object. 

         * 

         * 

         * 
Example
 

         * curl -X POST -d '{ 

         *  "parameters":[ 

         *      [ 

         *          { 

         *              "hostname": "host1", 

         *              "domain": "example.com", 

         *              "startCpus": 1, 

         *              "maxMemory": 1024, 

         *              "hourlyBillingFlag": true, 

         *              "localDiskFlag": true, 

         *              "operatingSystemReferenceCode": "UBUNTU_LATEST" 

         *          }, 

         *          { 

         *              "hostname": "host2", 

         *              "domain": "example.com", 

         *              "startCpus": 1, 

         *              "maxMemory": 1024, 

         *              "hourlyBillingFlag": true, 

         *              "localDiskFlag": true, 

         *              "operatingSystemReferenceCode": "UBUNTU_LATEST" 

         *          } 

         *      ] 

         *  ] 

         * }' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/createObjects.json 

         *  

         * HTTP/1.1 200 OK 

         * 

         * 

         * [ 

         *     { 

         *         "accountId": 232298, 

         *         "createDate": "2012-11-30T23:56:48-06:00", 

         *         "dedicatedAccountHostOnlyFlag": false, 

         *         "domain": "softlayer.com", 

         *         "hostname": "ubuntu1", 

         *         "id": 1301456, 

         *         "lastPowerStateId": null, 

         *         "lastVerifiedDate": null, 

         *         "maxCpu": 1, 

         *         "maxCpuUnits": "CORE", 

         *         "maxMemory": 1024, 

         *         "metricPollDate": null, 

         *         "modifyDate": null, 

         *         "privateNetworkOnlyFlag": false, 

         *         "startCpus": 1, 

         *         "statusId": 1001, 

         *         "globalIdentifier": "fed4c822-48c0-45d0-85e2-90476aa0c542" 

         *     }, 

         *     { 

         *         "accountId": 232298, 

         *         "createDate": "2012-11-30T23:56:49-06:00", 

         *         "dedicatedAccountHostOnlyFlag": false, 

         *         "domain": "softlayer.com", 

         *         "hostname": "ubuntu2", 

         *         "id": 1301457, 

         *         "lastPowerStateId": null, 

         *         "lastVerifiedDate": null, 

         *         "maxCpu": 1, 

         *         "maxCpuUnits": "CORE", 

         *         "maxMemory": 1024, 

         *         "metricPollDate": null, 

         *         "modifyDate": null, 

         *         "privateNetworkOnlyFlag": false, 

         *         "startCpus": 1, 

         *         "statusId": 1001, 

         *         "globalIdentifier": "bed4c686-9562-4ade-9049-dc4d5b6b200c" 

         *     } 

         * ] 

         *  
         *
         * @see SoftLayer_Virtual_Guest::createObjects
         */
        @ApiMethod
        public List createObjects(List templateObjects);

        /**
         * @see SoftLayer_Virtual_Guest::createPostSoftwareInstallTransaction
         */
        @ApiMethod(instanceRequired = true)
        public Boolean createPostSoftwareInstallTransaction(String data, Boolean returnBoolean);

        /**
         * 

         * This method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns. 
         *
         * @see SoftLayer_Virtual_Guest::deleteObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean deleteObject();

        /**
         * Creates a transaction to detach a guest's disk image. If the disk image is already detached it will be ignored. 

         * 

         * WARNING: The transaction created by this service will shut down the guest while the disk image is attached. The guest will be turned back on once this process is complete. 
         *
         * @see SoftLayer_Virtual_Guest::detachDiskImage
         */
        @ApiMethod(instanceRequired = true)
        public Transaction detachDiskImage(Long imageId);

        /**
         * Edit a computing instance's properties 
         *
         * @see SoftLayer_Virtual_Guest::editObject
         */
        @ApiMethod(instanceRequired = true)
        public Boolean editObject(Guest templateObject);

        /**
         * Reboot a guest into the Idera Bare Metal Restore image. 
         *
         * @see SoftLayer_Virtual_Guest::executeIderaBareMetalRestore
         */
        @ApiMethod(instanceRequired = true)
        public Boolean executeIderaBareMetalRestore();

        /**
         * Reboot a guest into the R1Soft Bare Metal Restore image. 
         *
         * @see SoftLayer_Virtual_Guest::executeR1SoftBareMetalRestore
         */
        @ApiMethod(instanceRequired = true)
        public Boolean executeR1SoftBareMetalRestore();

        /**
         * Reboot a Linux guest into the Xen rescue image. 
         *
         * @see SoftLayer_Virtual_Guest::executeRescueLayer
         */
        @ApiMethod(instanceRequired = true)
        public Boolean executeRescueLayer();

        /**
         * Find CCI by only its primary public or private IP address. IP addresses within secondary subnets tied to the CCI will not return the CCI. If no CCI is found, no errors are generated and no data is returned. 
         *
         * @see SoftLayer_Virtual_Guest::findByIpAddress
         */
        @ApiMethod
        public Guest findByIpAddress(String ipAddress);

        /**
         * 

         * Obtain an [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]]. 

         * 

         * 

         * This is primarily useful when there is a necessity to confirm the price which will be charged for an order. 

         * 

         * 

         * See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of the template object parameter. 
         *
         * @see SoftLayer_Virtual_Guest::generateOrderTemplate
         */
        @ApiMethod
        public Order generateOrderTemplate(Guest templateObject);

        /**
         * Returns monitoring alarm detailed history 
         *
         * @see SoftLayer_Virtual_Guest::getAlarmHistory
         */
        @ApiMethod(instanceRequired = true)
        public List getAlarmHistory(GregorianCalendar startDate, GregorianCalendar endDate, String alarmId);

        /**
         * @see SoftLayer_Virtual_Guest::getAvailableBlockDevicePositions
         */
        @ApiMethod(instanceRequired = true)
        public List getAvailableBlockDevicePositions();

        /**
         * Use this method when needing the metric data for bandwidth for a single guest.  It will gather the correct input parameters based on the date ranges 
         *
         * @see SoftLayer_Virtual_Guest::getBandwidthDataByDate
         */
        @ApiMethod(instanceRequired = true)
        public List getBandwidthDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType);

        /**
         * Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems. 
         *
         * @see SoftLayer_Virtual_Guest::getBandwidthForDateRange
         */
        @ApiMethod(instanceRequired = true)
        public List getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate);

        /**
         * Use this method when needing a bandwidth image for a single guest.  It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. 
         *
         * @see SoftLayer_Virtual_Guest::getBandwidthImage
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getBandwidthImage(String networkType, String snapshotRange, GregorianCalendar dateSpecified);

        /**
         * Use this method when needing a bandwidth image for a single guest.  It will gather the correct input parameters for the generic graphing utility based on the date ranges 
         *
         * @see SoftLayer_Virtual_Guest::getBandwidthImageByDate
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getBandwidthImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType);

        /**
         * Returns the total amount of bandwidth used during the time specified for a computing instance. 
         *
         * @see SoftLayer_Virtual_Guest::getBandwidthTotal
         */
        @ApiMethod(instanceRequired = true)
        public Long getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String side);

        /**
         * @see SoftLayer_Virtual_Guest::getBootOrder
         */
        @ApiMethod(instanceRequired = true)
        public String getBootOrder();

        /**
         * Gets the console access logs for a computing instance 
         *
         * @see SoftLayer_Virtual_Guest::getConsoleAccessLog
         */
        @ApiMethod(instanceRequired = true)
        public List getConsoleAccessLog();

        /**
         * If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price. Some operating systems (e.g., Red Hat Enterprise Linux) may be billed by the number of processor cores, so therefore require that a certain number of cores be present on the server. 
         *
         * @see SoftLayer_Virtual_Guest::getCoreRestrictedOperatingSystemPrice
         */
        @ApiMethod(instanceRequired = true)
        public Price getCoreRestrictedOperatingSystemPrice();

        /**
         * Use this method when needing the metric data for a single guest's CPUs.  It will gather the correct input parameters based on the date ranges 
         *
         * @see SoftLayer_Virtual_Guest::getCpuMetricDataByDate
         */
        @ApiMethod(instanceRequired = true)
        public List getCpuMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List cpuIndexes);

        /**
         * Use this method when needing a cpu usage image for a single guest.  It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. 
         *
         * @see SoftLayer_Virtual_Guest::getCpuMetricImage
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getCpuMetricImage(String snapshotRange, GregorianCalendar dateSpecified);

        /**
         * Use this method when needing a CPU usage image for a single guest.  It will gather the correct input parameters for the generic graphing utility based on the date ranges 
         *
         * @see SoftLayer_Virtual_Guest::getCpuMetricImageByDate
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getCpuMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List cpuIndexes);

        /**
         * 

         * There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are. 

         * 

         * 

         * Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Virtual_Guest_Configuration (type)]]. 
         *
         * @see SoftLayer_Virtual_Guest::getCreateObjectOptions
         */
        @ApiMethod
        public com.softlayer.api.service.container.virtual.guest.Configuration getCreateObjectOptions();

        /**
         * getUpgradeItemPrices() retrieves a list of all upgrades available to a CloudLayer Computing Instance. Upgradeable items include, but are not limited to, number of cores, amount of RAM, storage configuration, and network port speed. 
         *
         * @see SoftLayer_Virtual_Guest::getCurrentBillingDetail
         */
        @ApiMethod(instanceRequired = true)
        public List getCurrentBillingDetail();

        /**
         * Get the total billing price in US Dollars ($) for this instance. This includes all bandwidth used up to this point for this instance. 
         *
         * @see SoftLayer_Virtual_Guest::getCurrentBillingTotal
         */
        @ApiMethod(instanceRequired = true)
        public BigDecimal getCurrentBillingTotal();

        /**
         * Retrieve bandwidth graph by date. 
         *
         * @see SoftLayer_Virtual_Guest::getCustomBandwidthDataByDate
         */
        @ApiMethod(instanceRequired = true)
        public Graph getCustomBandwidthDataByDate(Graph graphData);

        /**
         * Retrieve bandwidth graph by date. 
         *
         * @see SoftLayer_Virtual_Guest::getCustomMetricDataByDate
         */
        @ApiMethod(instanceRequired = true)
        public Graph getCustomMetricDataByDate(Graph graphData);

        /**
         * Returns 2 tracking object data records.  The maximum and minimum dates that are available to received metric tracking data for a computing instance. 
         *
         * @see SoftLayer_Virtual_Guest::getDataMinMax
         */
        @ApiMethod(instanceRequired = true)
        public List getDataMinMax();

        /**
         * Return a drive retention SoftLayer_Item_Price object for a guest.
         *
         * @see SoftLayer_Virtual_Guest::getDriveRetentionItemPrice
         */
        @ApiMethod(instanceRequired = true)
        public Price getDriveRetentionItemPrice();

        /**
         * Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall. 
         *
         * @see SoftLayer_Virtual_Guest::getFirewallProtectableSubnets
         */
        @ApiMethod(instanceRequired = true)
        public List getFirewallProtectableSubnets();

        /**
         * @see SoftLayer_Virtual_Guest::getFirstAvailableBlockDevicePosition
         */
        @ApiMethod(instanceRequired = true)
        public String getFirstAvailableBlockDevicePosition();

        /**
         * @see SoftLayer_Virtual_Guest::getIsoBootImage
         */
        @ApiMethod(instanceRequired = true)
        public Image getIsoBootImage();

        /**
         * Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
         *
         * @see SoftLayer_Virtual_Guest::getItemPricesFromSoftwareDescriptions
         */
        @ApiMethod(instanceRequired = true)
        public List getItemPricesFromSoftwareDescriptions(List softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag);

        /**
         * Use this method when needing the metric data for memory for a single computing instance. 
         *
         * @see SoftLayer_Virtual_Guest::getMemoryMetricDataByDate
         */
        @ApiMethod(instanceRequired = true)
        public List getMemoryMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime);

        /**
         * Use this method when needing a memory usage image for a single guest.  It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. 
         *
         * @see SoftLayer_Virtual_Guest::getMemoryMetricImage
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getMemoryMetricImage(String snapshotRange, GregorianCalendar dateSpecified);

        /**
         * Use this method when needing a image displaying the amount of memory used over time for a single computing instance. It will gather the correct input parameters for the generic graphing utility based on the date ranges 
         *
         * @see SoftLayer_Virtual_Guest::getMemoryMetricImageByDate
         */
        @ApiMethod(instanceRequired = true)
        public GraphOutputs getMemoryMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime);

        /**
         * Returns open monitoring alarms for a given time period 
         *
         * @see SoftLayer_Virtual_Guest::getMonitoringActiveAlarms
         */
        @ApiMethod(instanceRequired = true)
        public List getMonitoringActiveAlarms(GregorianCalendar startDate, GregorianCalendar endDate);

        /**
         * Returns closed monitoring alarms for a given time period 
         *
         * @see SoftLayer_Virtual_Guest::getMonitoringClosedAlarms
         */
        @ApiMethod(instanceRequired = true)
        public List getMonitoringClosedAlarms(GregorianCalendar startDate, GregorianCalendar endDate);

        /**
         * Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this CloudLayer computing instance. Please use getFirewallProtectableSubnets to get all protectable subnets. 
         *
         * @see SoftLayer_Virtual_Guest::getNetworkComponentFirewallProtectableIpAddresses
         */
        @ApiMethod(instanceRequired = true)
        public List getNetworkComponentFirewallProtectableIpAddresses();

        /**
         * @see SoftLayer_Virtual_Guest::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Guest getObject();

        /**
         * Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. This container will include all services that the selected computing instance has. If desired you may remove prices which were returned. 
         *
         * @see SoftLayer_Virtual_Guest::getOrderTemplate
         */
        @ApiMethod(instanceRequired = true)
        public Order getOrderTemplate(String billingType, List orderPrices);

        /**
         * Recent metric data for a guest 
         *
         * @see SoftLayer_Virtual_Guest::getRecentMetricData
         */
        @ApiMethod(instanceRequired = true)
        public List