All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.softlayer.api.service.container.product.Order Maven / Gradle / Ivy

There is a newer version: 0.3.4
Show newest version
package com.softlayer.api.service.container.product;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Hardware;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.container.Exception;
import com.softlayer.api.service.container.product.item.category.question.Answer;
import com.softlayer.api.service.container.product.order.Property;
import com.softlayer.api.service.container.product.order.SshKeys;
import com.softlayer.api.service.container.product.order.billing.Information;
import com.softlayer.api.service.container.product.order.storage.Group;
import com.softlayer.api.service.product.item.Price;
import com.softlayer.api.service.sales.presale.Event;
import com.softlayer.api.service.virtual.Guest;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer. 
 *
 * @see SoftLayer_Container_Product_Order
 */
@ApiType("SoftLayer_Container_Product_Order")
public class Order extends Entity {

    /**
     * Flag for identifying an order for Big Data Deployment.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean bigDataOrderFlag;

    public Boolean getBigDataOrderFlag() {
        return bigDataOrderFlag;
    }

    public void setBigDataOrderFlag(Boolean bigDataOrderFlag) {
        bigDataOrderFlagSpecified = true;
        this.bigDataOrderFlag = bigDataOrderFlag;
    }

    protected boolean bigDataOrderFlagSpecified;

    public boolean isBigDataOrderFlagSpecified() {
        return bigDataOrderFlagSpecified;
    }

    public void unsetBigDataOrderFlag() {
        bigDataOrderFlag = null;
        bigDataOrderFlagSpecified = false;
    }

    /**
     * Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Information billingInformation;

    public Information getBillingInformation() {
        return billingInformation;
    }

    public void setBillingInformation(Information billingInformation) {
        billingInformationSpecified = true;
        this.billingInformation = billingInformation;
    }

    protected boolean billingInformationSpecified;

    public boolean isBillingInformationSpecified() {
        return billingInformationSpecified;
    }

    public void unsetBillingInformation() {
        billingInformation = null;
        billingInformationSpecified = false;
    }

    /**
     * This is the ID of the [[SoftLayer_Billing_Order_Item]] of this configuration/container. It is used for rebuilding an order container from a quote and is set automatically. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long billingOrderItemId;

    public Long getBillingOrderItemId() {
        return billingOrderItemId;
    }

    public void setBillingOrderItemId(Long billingOrderItemId) {
        billingOrderItemIdSpecified = true;
        this.billingOrderItemId = billingOrderItemId;
    }

    protected boolean billingOrderItemIdSpecified;

    public boolean isBillingOrderItemIdSpecified() {
        return billingOrderItemIdSpecified;
    }

    public void unsetBillingOrderItemId() {
        billingOrderItemId = null;
        billingOrderItemIdSpecified = false;
    }

    /**
     * The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String cancelUrl;

    public String getCancelUrl() {
        return cancelUrl;
    }

    public void setCancelUrl(String cancelUrl) {
        cancelUrlSpecified = true;
        this.cancelUrl = cancelUrl;
    }

    protected boolean cancelUrlSpecified;

    public boolean isCancelUrlSpecified() {
        return cancelUrlSpecified;
    }

    public void unsetCancelUrl() {
        cancelUrl = null;
        cancelUrlSpecified = false;
    }

    /**
     * User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple orderContainers) and you want to be able to easily determine one from another. Populating this value may be helpful if an exception is thrown when placing an order and it's tied to a specific order container. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String containerIdentifier;

    public String getContainerIdentifier() {
        return containerIdentifier;
    }

    public void setContainerIdentifier(String containerIdentifier) {
        containerIdentifierSpecified = true;
        this.containerIdentifier = containerIdentifier;
    }

    protected boolean containerIdentifierSpecified;

    public boolean isContainerIdentifierSpecified() {
        return containerIdentifierSpecified;
    }

    public void unsetContainerIdentifier() {
        containerIdentifier = null;
        containerIdentifierSpecified = false;
    }

    /**
     * This hash is internally-generated and is used to for tracking order containers.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String containerSplHash;

    public String getContainerSplHash() {
        return containerSplHash;
    }

    public void setContainerSplHash(String containerSplHash) {
        containerSplHashSpecified = true;
        this.containerSplHash = containerSplHash;
    }

    protected boolean containerSplHashSpecified;

    public boolean isContainerSplHashSpecified() {
        return containerSplHashSpecified;
    }

    public void unsetContainerSplHash() {
        containerSplHash = null;
        containerSplHashSpecified = false;
    }

    /**
     * The currency type chosen at checkout. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String currencyShortName;

    public String getCurrencyShortName() {
        return currencyShortName;
    }

    public void setCurrencyShortName(String currencyShortName) {
        currencyShortNameSpecified = true;
        this.currencyShortName = currencyShortName;
    }

    protected boolean currencyShortNameSpecified;

    public boolean isCurrencyShortNameSpecified() {
        return currencyShortNameSpecified;
    }

    public void unsetCurrencyShortName() {
        currencyShortName = null;
        currencyShortNameSpecified = false;
    }

    /**
     * This is the configuration identifier for tracking orders on the HTML order forms. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String displayLayerSessionId;

    public String getDisplayLayerSessionId() {
        return displayLayerSessionId;
    }

    public void setDisplayLayerSessionId(String displayLayerSessionId) {
        displayLayerSessionIdSpecified = true;
        this.displayLayerSessionId = displayLayerSessionId;
    }

    protected boolean displayLayerSessionIdSpecified;

    public boolean isDisplayLayerSessionIdSpecified() {
        return displayLayerSessionIdSpecified;
    }

    public void unsetDisplayLayerSessionId() {
        displayLayerSessionId = null;
        displayLayerSessionIdSpecified = false;
    }

    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean extendedHardwareTesting;

    public Boolean getExtendedHardwareTesting() {
        return extendedHardwareTesting;
    }

    public void setExtendedHardwareTesting(Boolean extendedHardwareTesting) {
        extendedHardwareTestingSpecified = true;
        this.extendedHardwareTesting = extendedHardwareTesting;
    }

    protected boolean extendedHardwareTestingSpecified;

    public boolean isExtendedHardwareTestingSpecified() {
        return extendedHardwareTestingSpecified;
    }

    public void unsetExtendedHardwareTesting() {
        extendedHardwareTesting = null;
        extendedHardwareTestingSpecified = false;
    }

    /**
     * For orders that contain servers (bare metal, virtual server, big data, etc.), the hardware property is required. This property is an array of [[SoftLayer_Hardware]] objects. The hostname and domain properties are required for each hardware object. Note that virtual server ([[SoftLayer_Container_Product_Order_Virtual_Guest]]) orders may populate this field instead of the virtualGuests property. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List hardware;

    public List getHardware() {
        if (hardware == null) {
            hardware = new ArrayList();
        }
        return hardware;
    }

    protected boolean hardwareSpecified;

    public boolean isHardwareSpecified() {
        return hardwareSpecified;
    }

    public void unsetHardware() {
        hardware = null;
        hardwareSpecified = false;
    }

    /**
     * An optional virtual disk image template identifier to be used as an installation base for a computing instance order
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String imageTemplateGlobalIdentifier;

    public String getImageTemplateGlobalIdentifier() {
        return imageTemplateGlobalIdentifier;
    }

    public void setImageTemplateGlobalIdentifier(String imageTemplateGlobalIdentifier) {
        imageTemplateGlobalIdentifierSpecified = true;
        this.imageTemplateGlobalIdentifier = imageTemplateGlobalIdentifier;
    }

    protected boolean imageTemplateGlobalIdentifierSpecified;

    public boolean isImageTemplateGlobalIdentifierSpecified() {
        return imageTemplateGlobalIdentifierSpecified;
    }

    public void unsetImageTemplateGlobalIdentifier() {
        imageTemplateGlobalIdentifier = null;
        imageTemplateGlobalIdentifierSpecified = false;
    }

    /**
     * An optional virtual disk image template identifier to be used as an installation base for a computing instance order
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long imageTemplateId;

    public Long getImageTemplateId() {
        return imageTemplateId;
    }

    public void setImageTemplateId(Long imageTemplateId) {
        imageTemplateIdSpecified = true;
        this.imageTemplateId = imageTemplateId;
    }

    protected boolean imageTemplateIdSpecified;

    public boolean isImageTemplateIdSpecified() {
        return imageTemplateIdSpecified;
    }

    public void unsetImageTemplateId() {
        imageTemplateId = null;
        imageTemplateIdSpecified = false;
    }

    /**
     * Flag to identify a "managed" order. This value is set internally.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long isManagedOrder;

    public Long getIsManagedOrder() {
        return isManagedOrder;
    }

    public void setIsManagedOrder(Long isManagedOrder) {
        isManagedOrderSpecified = true;
        this.isManagedOrder = isManagedOrder;
    }

    protected boolean isManagedOrderSpecified;

    public boolean isIsManagedOrderSpecified() {
        return isManagedOrderSpecified;
    }

    public void unsetIsManagedOrder() {
        isManagedOrder = null;
        isManagedOrderSpecified = false;
    }

    /**
     * The collection of [[SoftLayer_Container_Product_Item_Category_Question_Answer]] for any product category that has additional questions requiring user input. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List itemCategoryQuestionAnswers;

    public List getItemCategoryQuestionAnswers() {
        if (itemCategoryQuestionAnswers == null) {
            itemCategoryQuestionAnswers = new ArrayList();
        }
        return itemCategoryQuestionAnswers;
    }

    protected boolean itemCategoryQuestionAnswersSpecified;

    public boolean isItemCategoryQuestionAnswersSpecified() {
        return itemCategoryQuestionAnswersSpecified;
    }

    public void unsetItemCategoryQuestionAnswers() {
        itemCategoryQuestionAnswers = null;
        itemCategoryQuestionAnswersSpecified = false;
    }

    /**
     * The [[SoftLayer_Location_Region]] keyname or specific [[SoftLayer_Location_Datacenter]] id where the order should be provisioned. If this value is provided and the regionalGroup property is also specified, an exception will be thrown indicating that only 1 is allowed. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String location;

    public String getLocation() {
        return location;
    }

    public void setLocation(String location) {
        locationSpecified = true;
        this.location = location;
    }

    protected boolean locationSpecified;

    public boolean isLocationSpecified() {
        return locationSpecified;
    }

    public void unsetLocation() {
        location = null;
        locationSpecified = false;
    }

    /**
     * This [[SoftLayer_Location]] object will be determined from the location property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Location locationObject;

    public Location getLocationObject() {
        return locationObject;
    }

    public void setLocationObject(Location locationObject) {
        locationObjectSpecified = true;
        this.locationObject = locationObject;
    }

    protected boolean locationObjectSpecified;

    public boolean isLocationObjectSpecified() {
        return locationObjectSpecified;
    }

    public void unsetLocationObject() {
        locationObject = null;
        locationObjectSpecified = false;
    }

    /**
     * A generic message about the order. Does not need to be sent in with any orders. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        messageSpecified = true;
        this.message = message;
    }

    protected boolean messageSpecified;

    public boolean isMessageSpecified() {
        return messageSpecified;
    }

    public void unsetMessage() {
        message = null;
        messageSpecified = false;
    }

    /**
     * Orders may contain an array of configurations. Populating this property allows you to purchase multiple configurations within a single order. Each order container will have its own individual settings independent of the other order containers. For example, it is possible to order a bare metal server in one configuration and a virtual server in another. 
*
* If orderContainers is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, prices, location and packageId will be ignored on the base container, but since the billingInformation is a property that's not specific to a single order container (but the order as a whole) it must be populated on the base container. */ @ApiProperty(canBeNullOrNotSet = true) protected List orderContainers; public List getOrderContainers() { if (orderContainers == null) { orderContainers = new ArrayList(); } return orderContainers; } protected boolean orderContainersSpecified; public boolean isOrderContainersSpecified() { return orderContainersSpecified; } public void unsetOrderContainers() { orderContainers = null; orderContainersSpecified = false; } /** * Collection of hostnames of the order. This value is set internally and is not required for end users. */ @ApiProperty(canBeNullOrNotSet = true) protected List orderHostnames; public List getOrderHostnames() { if (orderHostnames == null) { orderHostnames = new ArrayList(); } return orderHostnames; } protected boolean orderHostnamesSpecified; public boolean isOrderHostnamesSpecified() { return orderHostnamesSpecified; } public void unsetOrderHostnames() { orderHostnames = null; orderHostnamesSpecified = false; } /** * Collection of exceptions resulting from the verification of the order. This value is set internally and is not required for end users when placing an order. When placing API orders, users can use this value to determine the container-specific exception that was thrown. */ @ApiProperty(canBeNullOrNotSet = true) protected List orderVerificationExceptions; public List getOrderVerificationExceptions() { if (orderVerificationExceptions == null) { orderVerificationExceptions = new ArrayList(); } return orderVerificationExceptions; } protected boolean orderVerificationExceptionsSpecified; public boolean isOrderVerificationExceptionsSpecified() { return orderVerificationExceptionsSpecified; } public void unsetOrderVerificationExceptions() { orderVerificationExceptions = null; orderVerificationExceptionsSpecified = false; } /** * The [[SoftLayer_Product_Package]] id for an order container. This is required to place an order. */ @ApiProperty(canBeNullOrNotSet = true) protected Long packageId; public Long getPackageId() { return packageId; } public void setPackageId(Long packageId) { packageIdSpecified = true; this.packageId = packageId; } protected boolean packageIdSpecified; public boolean isPackageIdSpecified() { return packageIdSpecified; } public void unsetPackageId() { packageId = null; packageIdSpecified = false; } /** * The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL */ @ApiProperty(canBeNullOrNotSet = true) protected String paymentType; public String getPaymentType() { return paymentType; } public void setPaymentType(String paymentType) { paymentTypeSpecified = true; this.paymentType = paymentType; } protected boolean paymentTypeSpecified; public boolean isPaymentTypeSpecified() { return paymentTypeSpecified; } public void unsetPaymentType() { paymentType = null; paymentTypeSpecified = false; } /** * The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal postTaxRecurring; public BigDecimal getPostTaxRecurring() { return postTaxRecurring; } public void setPostTaxRecurring(BigDecimal postTaxRecurring) { postTaxRecurringSpecified = true; this.postTaxRecurring = postTaxRecurring; } protected boolean postTaxRecurringSpecified; public boolean isPostTaxRecurringSpecified() { return postTaxRecurringSpecified; } public void unsetPostTaxRecurring() { postTaxRecurring = null; postTaxRecurringSpecified = false; } /** * The post-tax recurring hourly charge for the order. Since taxes are not calculated for hourly orders, this value will be the same as preTaxRecurringHourly. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal postTaxRecurringHourly; public BigDecimal getPostTaxRecurringHourly() { return postTaxRecurringHourly; } public void setPostTaxRecurringHourly(BigDecimal postTaxRecurringHourly) { postTaxRecurringHourlySpecified = true; this.postTaxRecurringHourly = postTaxRecurringHourly; } protected boolean postTaxRecurringHourlySpecified; public boolean isPostTaxRecurringHourlySpecified() { return postTaxRecurringHourlySpecified; } public void unsetPostTaxRecurringHourly() { postTaxRecurringHourly = null; postTaxRecurringHourlySpecified = false; } /** * The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal postTaxRecurringMonthly; public BigDecimal getPostTaxRecurringMonthly() { return postTaxRecurringMonthly; } public void setPostTaxRecurringMonthly(BigDecimal postTaxRecurringMonthly) { postTaxRecurringMonthlySpecified = true; this.postTaxRecurringMonthly = postTaxRecurringMonthly; } protected boolean postTaxRecurringMonthlySpecified; public boolean isPostTaxRecurringMonthlySpecified() { return postTaxRecurringMonthlySpecified; } public void unsetPostTaxRecurringMonthly() { postTaxRecurringMonthly = null; postTaxRecurringMonthlySpecified = false; } /** * The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal postTaxSetup; public BigDecimal getPostTaxSetup() { return postTaxSetup; } public void setPostTaxSetup(BigDecimal postTaxSetup) { postTaxSetupSpecified = true; this.postTaxSetup = postTaxSetup; } protected boolean postTaxSetupSpecified; public boolean isPostTaxSetupSpecified() { return postTaxSetupSpecified; } public void unsetPostTaxSetup() { postTaxSetup = null; postTaxSetupSpecified = false; } /** * The pre-tax recurring total of the order. If there are mixed monthly and hourly prices on the order, this will be the sum of preTaxRecurringHourly and preTaxRecurringMonthly. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal preTaxRecurring; public BigDecimal getPreTaxRecurring() { return preTaxRecurring; } public void setPreTaxRecurring(BigDecimal preTaxRecurring) { preTaxRecurringSpecified = true; this.preTaxRecurring = preTaxRecurring; } protected boolean preTaxRecurringSpecified; public boolean isPreTaxRecurringSpecified() { return preTaxRecurringSpecified; } public void unsetPreTaxRecurring() { preTaxRecurring = null; preTaxRecurringSpecified = false; } /** * The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal preTaxRecurringHourly; public BigDecimal getPreTaxRecurringHourly() { return preTaxRecurringHourly; } public void setPreTaxRecurringHourly(BigDecimal preTaxRecurringHourly) { preTaxRecurringHourlySpecified = true; this.preTaxRecurringHourly = preTaxRecurringHourly; } protected boolean preTaxRecurringHourlySpecified; public boolean isPreTaxRecurringHourlySpecified() { return preTaxRecurringHourlySpecified; } public void unsetPreTaxRecurringHourly() { preTaxRecurringHourly = null; preTaxRecurringHourlySpecified = false; } /** * The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal preTaxRecurringMonthly; public BigDecimal getPreTaxRecurringMonthly() { return preTaxRecurringMonthly; } public void setPreTaxRecurringMonthly(BigDecimal preTaxRecurringMonthly) { preTaxRecurringMonthlySpecified = true; this.preTaxRecurringMonthly = preTaxRecurringMonthly; } protected boolean preTaxRecurringMonthlySpecified; public boolean isPreTaxRecurringMonthlySpecified() { return preTaxRecurringMonthlySpecified; } public void unsetPreTaxRecurringMonthly() { preTaxRecurringMonthly = null; preTaxRecurringMonthlySpecified = false; } /** * The pre-tax setup fee total of the order. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal preTaxSetup; public BigDecimal getPreTaxSetup() { return preTaxSetup; } public void setPreTaxSetup(BigDecimal preTaxSetup) { preTaxSetupSpecified = true; this.preTaxSetup = preTaxSetup; } protected boolean preTaxSetupSpecified; public boolean isPreTaxSetupSpecified() { return preTaxSetupSpecified; } public void unsetPreTaxSetup() { preTaxSetup = null; preTaxSetupSpecified = false; } /** * If there are any presale events available for an order, this value will be populated. It is set internally and is not required for end users when placing an order. See [[SoftLayer_Sales_Presale_Event]] for more info. */ @ApiProperty(canBeNullOrNotSet = true) protected Event presaleEvent; public Event getPresaleEvent() { return presaleEvent; } public void setPresaleEvent(Event presaleEvent) { presaleEventSpecified = true; this.presaleEvent = presaleEvent; } protected boolean presaleEventSpecified; public boolean isPresaleEventSpecified() { return presaleEventSpecified; } public void unsetPresaleEvent() { presaleEvent = null; presaleEventSpecified = false; } /** * A preset configuration id for the package. Is required if not submitting any prices. */ @ApiProperty(canBeNullOrNotSet = true) protected Long presetId; public Long getPresetId() { return presetId; } public void setPresetId(Long presetId) { presetIdSpecified = true; this.presetId = presetId; } protected boolean presetIdSpecified; public boolean isPresetIdSpecified() { return presetIdSpecified; } public void unsetPresetId() { presetId = null; presetIdSpecified = false; } /** * This is a collection of [[SoftLayer_Product_Item_Price]] objects. The only required property to populate for an item price object when ordering is its id - all other supplied information about the price (e.g., recurringFee, setupFee, etc.) will be ignored. Unless the [[SoftLayer_Product_Package]] associated with the order allows for preset prices, this property is required to place an order. */ @ApiProperty(canBeNullOrNotSet = true) protected List prices; public List getPrices() { if (prices == null) { prices = new ArrayList(); } return prices; } protected boolean pricesSpecified; public boolean isPricesSpecified() { return pricesSpecified; } public void unsetPrices() { prices = null; pricesSpecified = false; } /** * The id of a [[SoftLayer_Hardware_Component_Partition_Template]]. This property is optional. If no partition template is provided, a default will be used according to the operating system chosen with the order. Using the [[SoftLayer_Hardware_Component_Partition_OperatingSystem]] service, getPartitionTemplates will return those available for the particular operating system. */ @ApiProperty(canBeNullOrNotSet = true) protected Long primaryDiskPartitionId; public Long getPrimaryDiskPartitionId() { return primaryDiskPartitionId; } public void setPrimaryDiskPartitionId(Long primaryDiskPartitionId) { primaryDiskPartitionIdSpecified = true; this.primaryDiskPartitionId = primaryDiskPartitionId; } protected boolean primaryDiskPartitionIdSpecified; public boolean isPrimaryDiskPartitionIdSpecified() { return primaryDiskPartitionIdSpecified; } public void unsetPrimaryDiskPartitionId() { primaryDiskPartitionId = null; primaryDiskPartitionIdSpecified = false; } /** * Priorities to set on replication set servers. */ @ApiProperty(canBeNullOrNotSet = true) protected List priorities; public List getPriorities() { if (priorities == null) { priorities = new ArrayList(); } return priorities; } protected boolean prioritiesSpecified; public boolean isPrioritiesSpecified() { return prioritiesSpecified; } public void unsetPriorities() { priorities = null; prioritiesSpecified = false; } /** * Flag for identifying a container as Virtual Server (Private Node). */ @ApiProperty(canBeNullOrNotSet = true) protected Boolean privateCloudOrderFlag; public Boolean getPrivateCloudOrderFlag() { return privateCloudOrderFlag; } public void setPrivateCloudOrderFlag(Boolean privateCloudOrderFlag) { privateCloudOrderFlagSpecified = true; this.privateCloudOrderFlag = privateCloudOrderFlag; } protected boolean privateCloudOrderFlagSpecified; public boolean isPrivateCloudOrderFlagSpecified() { return privateCloudOrderFlagSpecified; } public void unsetPrivateCloudOrderFlag() { privateCloudOrderFlag = null; privateCloudOrderFlagSpecified = false; } /** * Type of Virtual Server (Private Node) order. Potential values: INITIAL, ADDHOST, ADDIPS, ADDZONE */ @ApiProperty(canBeNullOrNotSet = true) protected String privateCloudOrderType; public String getPrivateCloudOrderType() { return privateCloudOrderType; } public void setPrivateCloudOrderType(String privateCloudOrderType) { privateCloudOrderTypeSpecified = true; this.privateCloudOrderType = privateCloudOrderType; } protected boolean privateCloudOrderTypeSpecified; public boolean isPrivateCloudOrderTypeSpecified() { return privateCloudOrderTypeSpecified; } public void unsetPrivateCloudOrderType() { privateCloudOrderType = null; privateCloudOrderTypeSpecified = false; } /** * Optional promotion code for an order. */ @ApiProperty(canBeNullOrNotSet = true) protected String promotionCode; public String getPromotionCode() { return promotionCode; } public void setPromotionCode(String promotionCode) { promotionCodeSpecified = true; this.promotionCode = promotionCode; } protected boolean promotionCodeSpecified; public boolean isPromotionCodeSpecified() { return promotionCodeSpecified; } public void unsetPromotionCode() { promotionCode = null; promotionCodeSpecified = false; } /** * Generic properties. */ @ApiProperty(canBeNullOrNotSet = true) protected List properties; public List getProperties() { if (properties == null) { properties = new ArrayList(); } return properties; } protected boolean propertiesSpecified; public boolean isPropertiesSpecified() { return propertiesSpecified; } public void unsetProperties() { properties = null; propertiesSpecified = false; } /** * The Prorated Initial Charge plus the balance on the account. Only the recurring fees are prorated. Here's how the calculation works: We take the postTaxRecurring value and we prorate it based on the time between now and the next bill date for this account. After this, we add in the setup fee since this is not prorated. Then, if there is a balance on the account, we add that to the account. In the event that there is a credit balance on the account, we will subtract this amount from the order total. If the credit balance on the account is greater than the prorated initial charge, the order will go through without a charge to the credit card on the account or requiring a paypal payment. The credit on the account will be reduced by the order total, and the order will await approval from sales, as normal. If there is a pending order already in the system, We will ignore the balance on the account completely, in the calculation of the initial charge. This is to protect against two orders coming into the system and getting the benefit of a credit balance, or worse, both orders being charged the order amount + the balance on the account. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal proratedInitialCharge; public BigDecimal getProratedInitialCharge() { return proratedInitialCharge; } public void setProratedInitialCharge(BigDecimal proratedInitialCharge) { proratedInitialChargeSpecified = true; this.proratedInitialCharge = proratedInitialCharge; } protected boolean proratedInitialChargeSpecified; public boolean isProratedInitialChargeSpecified() { return proratedInitialChargeSpecified; } public void unsetProratedInitialCharge() { proratedInitialCharge = null; proratedInitialChargeSpecified = false; } /** * This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal proratedOrderTotal; public BigDecimal getProratedOrderTotal() { return proratedOrderTotal; } public void setProratedOrderTotal(BigDecimal proratedOrderTotal) { proratedOrderTotalSpecified = true; this.proratedOrderTotal = proratedOrderTotal; } protected boolean proratedOrderTotalSpecified; public boolean isProratedOrderTotalSpecified() { return proratedOrderTotalSpecified; } public void unsetProratedOrderTotal() { proratedOrderTotal = null; proratedOrderTotalSpecified = false; } /** * The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. */ @ApiProperty(canBeNullOrNotSet = true) protected List provisionScripts; public List getProvisionScripts() { if (provisionScripts == null) { provisionScripts = new ArrayList(); } return provisionScripts; } protected boolean provisionScriptsSpecified; public boolean isProvisionScriptsSpecified() { return provisionScriptsSpecified; } public void unsetProvisionScripts() { provisionScripts = null; provisionScriptsSpecified = false; } /** * The quantity of the item being ordered */ @ApiProperty(canBeNullOrNotSet = true) protected Long quantity; public Long getQuantity() { return quantity; } public void setQuantity(Long quantity) { quantitySpecified = true; this.quantity = quantity; } protected boolean quantitySpecified; public boolean isQuantitySpecified() { return quantitySpecified; } public void unsetQuantity() { quantity = null; quantitySpecified = false; } /** * A custom name to be assigned to the quote. */ @ApiProperty(canBeNullOrNotSet = true) protected String quoteName; public String getQuoteName() { return quoteName; } public void setQuoteName(String quoteName) { quoteNameSpecified = true; this.quoteName = quoteName; } protected boolean quoteNameSpecified; public boolean isQuoteNameSpecified() { return quoteNameSpecified; } public void unsetQuoteName() { quoteName = null; quoteNameSpecified = false; } /** * Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See [[SoftLayer_Location_Group_Regional]] to get a list of available regional group names.
*
* location and regionalGroup are mutually exclusive on an order container. If both location and regionalGroup are provided, an exception will be thrown indicating that only 1 is allowed.
*
* If a regional group is provided and VLANs are specified (within the hardware or virtualGuests properties), we will use the datacenter where the VLANs are located. If no VLANs are specified, we will use the preferred datacenter on the regional group object. */ @ApiProperty(canBeNullOrNotSet = true) protected String regionalGroup; public String getRegionalGroup() { return regionalGroup; } public void setRegionalGroup(String regionalGroup) { regionalGroupSpecified = true; this.regionalGroup = regionalGroup; } protected boolean regionalGroupSpecified; public boolean isRegionalGroupSpecified() { return regionalGroupSpecified; } public void unsetRegionalGroup() { regionalGroup = null; regionalGroupSpecified = false; } /** * An optional resource group identifier specifying the resource group to attach the order to */ @ApiProperty(canBeNullOrNotSet = true) protected Long resourceGroupId; public Long getResourceGroupId() { return resourceGroupId; } public void setResourceGroupId(Long resourceGroupId) { resourceGroupIdSpecified = true; this.resourceGroupId = resourceGroupId; } protected boolean resourceGroupIdSpecified; public boolean isResourceGroupIdSpecified() { return resourceGroupIdSpecified; } public void unsetResourceGroupId() { resourceGroupId = null; resourceGroupIdSpecified = false; } /** * This variable specifies the name of the resource group the server configuration belongs to. For MongoDB Replica sets, it would be the replica set name. */ @ApiProperty(canBeNullOrNotSet = true) protected String resourceGroupName; public String getResourceGroupName() { return resourceGroupName; } public void setResourceGroupName(String resourceGroupName) { resourceGroupNameSpecified = true; this.resourceGroupName = resourceGroupName; } protected boolean resourceGroupNameSpecified; public boolean isResourceGroupNameSpecified() { return resourceGroupNameSpecified; } public void unsetResourceGroupName() { resourceGroupName = null; resourceGroupNameSpecified = false; } /** * An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. */ @ApiProperty(canBeNullOrNotSet = true) protected Long resourceGroupTemplateId; public Long getResourceGroupTemplateId() { return resourceGroupTemplateId; } public void setResourceGroupTemplateId(Long resourceGroupTemplateId) { resourceGroupTemplateIdSpecified = true; this.resourceGroupTemplateId = resourceGroupTemplateId; } protected boolean resourceGroupTemplateIdSpecified; public boolean isResourceGroupTemplateIdSpecified() { return resourceGroupTemplateIdSpecified; } public void unsetResourceGroupTemplateId() { resourceGroupTemplateId = null; resourceGroupTemplateIdSpecified = false; } /** * The URL to which PayPal redirects browser after a payment is completed. */ @ApiProperty(canBeNullOrNotSet = true) protected String returnUrl; public String getReturnUrl() { return returnUrl; } public void setReturnUrl(String returnUrl) { returnUrlSpecified = true; this.returnUrl = returnUrl; } protected boolean returnUrlSpecified; public boolean isReturnUrlSpecified() { return returnUrlSpecified; } public void unsetReturnUrl() { returnUrl = null; returnUrlSpecified = false; } /** * This flag indicates that the quote should be sent to the email address associated with the account or order. */ @ApiProperty(canBeNullOrNotSet = true) protected Boolean sendQuoteEmailFlag; public Boolean getSendQuoteEmailFlag() { return sendQuoteEmailFlag; } public void setSendQuoteEmailFlag(Boolean sendQuoteEmailFlag) { sendQuoteEmailFlagSpecified = true; this.sendQuoteEmailFlag = sendQuoteEmailFlag; } protected boolean sendQuoteEmailFlagSpecified; public boolean isSendQuoteEmailFlagSpecified() { return sendQuoteEmailFlagSpecified; } public void unsetSendQuoteEmailFlag() { sendQuoteEmailFlag = null; sendQuoteEmailFlagSpecified = false; } /** * The number of cores for the server being ordered. This value is set internally. */ @ApiProperty(canBeNullOrNotSet = true) protected Long serverCoreCount; public Long getServerCoreCount() { return serverCoreCount; } public void setServerCoreCount(Long serverCoreCount) { serverCoreCountSpecified = true; this.serverCoreCount = serverCoreCount; } protected boolean serverCoreCountSpecified; public boolean isServerCoreCountSpecified() { return serverCoreCountSpecified; } public void unsetServerCoreCount() { serverCoreCount = null; serverCoreCountSpecified = false; } /** * An optional computing instance identifier to be used as an installation base for a computing instance order */ @ApiProperty(canBeNullOrNotSet = true) protected Long sourceVirtualGuestId; public Long getSourceVirtualGuestId() { return sourceVirtualGuestId; } public void setSourceVirtualGuestId(Long sourceVirtualGuestId) { sourceVirtualGuestIdSpecified = true; this.sourceVirtualGuestId = sourceVirtualGuestId; } protected boolean sourceVirtualGuestIdSpecified; public boolean isSourceVirtualGuestIdSpecified() { return sourceVirtualGuestIdSpecified; } public void unsetSourceVirtualGuestId() { sourceVirtualGuestId = null; sourceVirtualGuestIdSpecified = false; } /** * The containers which hold SoftLayer_Security_Ssh_Key IDs to add to their respective servers. The order of containers passed in needs to match the order they are assigned to either hardware or virtualGuests. SSH Keys will not be assigned for servers with Microsoft Windows. */ @ApiProperty(canBeNullOrNotSet = true) protected List sshKeys; public List getSshKeys() { if (sshKeys == null) { sshKeys = new ArrayList(); } return sshKeys; } protected boolean sshKeysSpecified; public boolean isSshKeysSpecified() { return sshKeysSpecified; } public void unsetSshKeys() { sshKeys = null; sshKeysSpecified = false; } /** * An optional parameter for step-based order processing. */ @ApiProperty(canBeNullOrNotSet = true) protected Long stepId; public Long getStepId() { return stepId; } public void setStepId(Long stepId) { stepIdSpecified = true; this.stepId = stepId; } protected boolean stepIdSpecified; public boolean isStepIdSpecified() { return stepIdSpecified; } public void unsetStepId() { stepId = null; stepIdSpecified = false; } /** *
*
* For orders that want to add storage groups such as RAID across multiple disks, simply add [[SoftLayer_Container_Product_Order_Storage_Group]] objects to this array. Storage groups will only be used if the 'RAID' disk controller price is selected. Any other disk controller types will ignore the storage groups set here.
*
* The first storage group in this array will be considered the primary storage group, which is used for the OS. Any other storage groups will act as data storage.
*
*/ @ApiProperty(canBeNullOrNotSet = true) protected List storageGroups; public List getStorageGroups() { if (storageGroups == null) { storageGroups = new ArrayList(); } return storageGroups; } protected boolean storageGroupsSpecified; public boolean isStorageGroupsSpecified() { return storageGroupsSpecified; } public void unsetStorageGroups() { storageGroups = null; storageGroupsSpecified = false; } /** * The order container may not contain the final tax rates when it is returned from [[SoftLayer_Product_Order/verifyOrder|verifyOrder]]. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. */ @ApiProperty(canBeNullOrNotSet = true) protected String taxCacheHash; public String getTaxCacheHash() { return taxCacheHash; } public void setTaxCacheHash(String taxCacheHash) { taxCacheHashSpecified = true; this.taxCacheHash = taxCacheHash; } protected boolean taxCacheHashSpecified; public boolean isTaxCacheHashSpecified() { return taxCacheHashSpecified; } public void unsetTaxCacheHash() { taxCacheHash = null; taxCacheHashSpecified = false; } /** * Flag to indicate if the order container has the final tax rates for the order. Some tax rates are calculated in the background because they take longer, and they might not be finished when the container is returned from [[SoftLayer_Product_Order/verifyOrder|verifyOrder]]. */ @ApiProperty(canBeNullOrNotSet = true) protected Boolean taxCompletedFlag; public Boolean getTaxCompletedFlag() { return taxCompletedFlag; } public void setTaxCompletedFlag(Boolean taxCompletedFlag) { taxCompletedFlagSpecified = true; this.taxCompletedFlag = taxCompletedFlag; } protected boolean taxCompletedFlagSpecified; public boolean isTaxCompletedFlagSpecified() { return taxCompletedFlagSpecified; } public void unsetTaxCompletedFlag() { taxCompletedFlag = null; taxCompletedFlagSpecified = false; } /** * The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. */ @ApiProperty(canBeNullOrNotSet = true) protected Price techIncubatorItemPrice; public Price getTechIncubatorItemPrice() { return techIncubatorItemPrice; } public void setTechIncubatorItemPrice(Price techIncubatorItemPrice) { techIncubatorItemPriceSpecified = true; this.techIncubatorItemPrice = techIncubatorItemPrice; } protected boolean techIncubatorItemPriceSpecified; public boolean isTechIncubatorItemPriceSpecified() { return techIncubatorItemPriceSpecified; } public void unsetTechIncubatorItemPrice() { techIncubatorItemPrice = null; techIncubatorItemPriceSpecified = false; } /** * The total tax portion of the recurring fees. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal totalRecurringTax; public BigDecimal getTotalRecurringTax() { return totalRecurringTax; } public void setTotalRecurringTax(BigDecimal totalRecurringTax) { totalRecurringTaxSpecified = true; this.totalRecurringTax = totalRecurringTax; } protected boolean totalRecurringTaxSpecified; public boolean isTotalRecurringTaxSpecified() { return totalRecurringTaxSpecified; } public void unsetTotalRecurringTax() { totalRecurringTax = null; totalRecurringTaxSpecified = false; } /** * The tax amount of the setup fees. */ @ApiProperty(canBeNullOrNotSet = true) protected BigDecimal totalSetupTax; public BigDecimal getTotalSetupTax() { return totalSetupTax; } public void setTotalSetupTax(BigDecimal totalSetupTax) { totalSetupTaxSpecified = true; this.totalSetupTax = totalSetupTax; } protected boolean totalSetupTaxSpecified; public boolean isTotalSetupTaxSpecified() { return totalSetupTaxSpecified; } public void unsetTotalSetupTax() { totalSetupTax = null; totalSetupTaxSpecified = false; } /** * An optional flag to use hourly pricing instead of standard monthly pricing. */ @ApiProperty(canBeNullOrNotSet = true) protected Boolean useHourlyPricing; public Boolean getUseHourlyPricing() { return useHourlyPricing; } public void setUseHourlyPricing(Boolean useHourlyPricing) { useHourlyPricingSpecified = true; this.useHourlyPricing = useHourlyPricing; } protected boolean useHourlyPricingSpecified; public boolean isUseHourlyPricingSpecified() { return useHourlyPricingSpecified; } public void unsetUseHourlyPricing() { useHourlyPricing = null; useHourlyPricingSpecified = false; } /** * For virtual guest (virtual server) orders, this property is required if you did not specify data in the hardware property. This is an array of [[SoftLayer_Virtual_Guest]] objects. The hostname and domain properties are required for each virtual guest object. There is no need to specify data in this property and the hardware property - only one is required for virtual server orders. */ @ApiProperty(canBeNullOrNotSet = true) protected List virtualGuests; public List getVirtualGuests() { if (virtualGuests == null) { virtualGuests = new ArrayList(); } return virtualGuests; } protected boolean virtualGuestsSpecified; public boolean isVirtualGuestsSpecified() { return virtualGuestsSpecified; } public void unsetVirtualGuests() { virtualGuests = null; virtualGuestsSpecified = false; } public static class Mask extends com.softlayer.api.service.Entity.Mask { public Mask bigDataOrderFlag() { withLocalProperty("bigDataOrderFlag"); return this; } public com.softlayer.api.service.container.product.order.billing.Information.Mask billingInformation() { return withSubMask("billingInformation", com.softlayer.api.service.container.product.order.billing.Information.Mask.class); } public Mask billingOrderItemId() { withLocalProperty("billingOrderItemId"); return this; } public Mask cancelUrl() { withLocalProperty("cancelUrl"); return this; } public Mask containerIdentifier() { withLocalProperty("containerIdentifier"); return this; } public Mask containerSplHash() { withLocalProperty("containerSplHash"); return this; } public Mask currencyShortName() { withLocalProperty("currencyShortName"); return this; } public Mask displayLayerSessionId() { withLocalProperty("displayLayerSessionId"); return this; } public Mask extendedHardwareTesting() { withLocalProperty("extendedHardwareTesting"); return this; } public com.softlayer.api.service.Hardware.Mask hardware() { return withSubMask("hardware", com.softlayer.api.service.Hardware.Mask.class); } public Mask imageTemplateGlobalIdentifier() { withLocalProperty("imageTemplateGlobalIdentifier"); return this; } public Mask imageTemplateId() { withLocalProperty("imageTemplateId"); return this; } public Mask isManagedOrder() { withLocalProperty("isManagedOrder"); return this; } public com.softlayer.api.service.container.product.item.category.question.Answer.Mask itemCategoryQuestionAnswers() { return withSubMask("itemCategoryQuestionAnswers", com.softlayer.api.service.container.product.item.category.question.Answer.Mask.class); } public Mask location() { withLocalProperty("location"); return this; } public com.softlayer.api.service.Location.Mask locationObject() { return withSubMask("locationObject", com.softlayer.api.service.Location.Mask.class); } public Mask message() { withLocalProperty("message"); return this; } public Order.Mask orderContainers() { return withSubMask("orderContainers", Order.Mask.class); } public Mask orderHostnames() { withLocalProperty("orderHostnames"); return this; } public com.softlayer.api.service.container.Exception.Mask orderVerificationExceptions() { return withSubMask("orderVerificationExceptions", com.softlayer.api.service.container.Exception.Mask.class); } public Mask packageId() { withLocalProperty("packageId"); return this; } public Mask paymentType() { withLocalProperty("paymentType"); return this; } public Mask postTaxRecurring() { withLocalProperty("postTaxRecurring"); return this; } public Mask postTaxRecurringHourly() { withLocalProperty("postTaxRecurringHourly"); return this; } public Mask postTaxRecurringMonthly() { withLocalProperty("postTaxRecurringMonthly"); return this; } public Mask postTaxSetup() { withLocalProperty("postTaxSetup"); return this; } public Mask preTaxRecurring() { withLocalProperty("preTaxRecurring"); return this; } public Mask preTaxRecurringHourly() { withLocalProperty("preTaxRecurringHourly"); return this; } public Mask preTaxRecurringMonthly() { withLocalProperty("preTaxRecurringMonthly"); return this; } public Mask preTaxSetup() { withLocalProperty("preTaxSetup"); return this; } public com.softlayer.api.service.sales.presale.Event.Mask presaleEvent() { return withSubMask("presaleEvent", com.softlayer.api.service.sales.presale.Event.Mask.class); } public Mask presetId() { withLocalProperty("presetId"); return this; } public com.softlayer.api.service.product.item.Price.Mask prices() { return withSubMask("prices", com.softlayer.api.service.product.item.Price.Mask.class); } public Mask primaryDiskPartitionId() { withLocalProperty("primaryDiskPartitionId"); return this; } public Mask priorities() { withLocalProperty("priorities"); return this; } public Mask privateCloudOrderFlag() { withLocalProperty("privateCloudOrderFlag"); return this; } public Mask privateCloudOrderType() { withLocalProperty("privateCloudOrderType"); return this; } public Mask promotionCode() { withLocalProperty("promotionCode"); return this; } public com.softlayer.api.service.container.product.order.Property.Mask properties() { return withSubMask("properties", com.softlayer.api.service.container.product.order.Property.Mask.class); } public Mask proratedInitialCharge() { withLocalProperty("proratedInitialCharge"); return this; } public Mask proratedOrderTotal() { withLocalProperty("proratedOrderTotal"); return this; } public Mask provisionScripts() { withLocalProperty("provisionScripts"); return this; } public Mask quantity() { withLocalProperty("quantity"); return this; } public Mask quoteName() { withLocalProperty("quoteName"); return this; } public Mask regionalGroup() { withLocalProperty("regionalGroup"); return this; } public Mask resourceGroupId() { withLocalProperty("resourceGroupId"); return this; } public Mask resourceGroupName() { withLocalProperty("resourceGroupName"); return this; } public Mask resourceGroupTemplateId() { withLocalProperty("resourceGroupTemplateId"); return this; } public Mask returnUrl() { withLocalProperty("returnUrl"); return this; } public Mask sendQuoteEmailFlag() { withLocalProperty("sendQuoteEmailFlag"); return this; } public Mask serverCoreCount() { withLocalProperty("serverCoreCount"); return this; } public Mask sourceVirtualGuestId() { withLocalProperty("sourceVirtualGuestId"); return this; } public com.softlayer.api.service.container.product.order.SshKeys.Mask sshKeys() { return withSubMask("sshKeys", com.softlayer.api.service.container.product.order.SshKeys.Mask.class); } public Mask stepId() { withLocalProperty("stepId"); return this; } public com.softlayer.api.service.container.product.order.storage.Group.Mask storageGroups() { return withSubMask("storageGroups", com.softlayer.api.service.container.product.order.storage.Group.Mask.class); } public Mask taxCacheHash() { withLocalProperty("taxCacheHash"); return this; } public Mask taxCompletedFlag() { withLocalProperty("taxCompletedFlag"); return this; } public com.softlayer.api.service.product.item.Price.Mask techIncubatorItemPrice() { return withSubMask("techIncubatorItemPrice", com.softlayer.api.service.product.item.Price.Mask.class); } public Mask totalRecurringTax() { withLocalProperty("totalRecurringTax"); return this; } public Mask totalSetupTax() { withLocalProperty("totalSetupTax"); return this; } public Mask useHourlyPricing() { withLocalProperty("useHourlyPricing"); return this; } public com.softlayer.api.service.virtual.Guest.Mask virtualGuests() { return withSubMask("virtualGuests", com.softlayer.api.service.virtual.Guest.Mask.class); } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy