com.softlayer.api.service.container.hardware.server.Configuration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service.container.hardware.server;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.hardware.Component;
import com.softlayer.api.service.product.item.Price;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Container_Hardware_Server_Configuration data type contains information relating to a server's item price information, and hard drive partition information. 
 *
 * @see SoftLayer_Container_Hardware_Server_Configuration
 */
@ApiType("SoftLayer_Container_Hardware_Server_Configuration")
public class Configuration extends Entity {

    /**
     * A flag indicating that the server will be moved into the spare pool after an Operating system reload.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long addToSparePoolAfterOsReload;

    public Long getAddToSparePoolAfterOsReload() {
        return addToSparePoolAfterOsReload;
    }

    public void setAddToSparePoolAfterOsReload(Long addToSparePoolAfterOsReload) {
        addToSparePoolAfterOsReloadSpecified = true;
        this.addToSparePoolAfterOsReload = addToSparePoolAfterOsReload;
    }

    protected boolean addToSparePoolAfterOsReloadSpecified;

    public boolean isAddToSparePoolAfterOsReloadSpecified() {
        return addToSparePoolAfterOsReloadSpecified;
    }

    public void unsetAddToSparePoolAfterOsReload() {
        addToSparePoolAfterOsReload = null;
        addToSparePoolAfterOsReloadSpecified = false;
    }

    /**
     * The customer provision uri will be used to download and execute a customer defined script on the host at the end of provisioning.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String customProvisionScriptUri;

    public String getCustomProvisionScriptUri() {
        return customProvisionScriptUri;
    }

    public void setCustomProvisionScriptUri(String customProvisionScriptUri) {
        customProvisionScriptUriSpecified = true;
        this.customProvisionScriptUri = customProvisionScriptUri;
    }

    protected boolean customProvisionScriptUriSpecified;

    public boolean isCustomProvisionScriptUriSpecified() {
        return customProvisionScriptUriSpecified;
    }

    public void unsetCustomProvisionScriptUri() {
        customProvisionScriptUri = null;
        customProvisionScriptUriSpecified = false;
    }

    /**
     * A flag indicating that the primary drive will be converted to a portable storage volume during an Operating System reload.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Boolean driveRetentionFlag;

    public Boolean getDriveRetentionFlag() {
        return driveRetentionFlag;
    }

    public void setDriveRetentionFlag(Boolean driveRetentionFlag) {
        driveRetentionFlagSpecified = true;
        this.driveRetentionFlag = driveRetentionFlag;
    }

    protected boolean driveRetentionFlagSpecified;

    public boolean isDriveRetentionFlagSpecified() {
        return driveRetentionFlagSpecified;
    }

    public void unsetDriveRetentionFlag() {
        driveRetentionFlag = null;
        driveRetentionFlagSpecified = false;
    }

    /**
     * A flag indicating that all data will be erased from drives during an Operating System reload.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long eraseHardDrives;

    public Long getEraseHardDrives() {
        return eraseHardDrives;
    }

    public void setEraseHardDrives(Long eraseHardDrives) {
        eraseHardDrivesSpecified = true;
        this.eraseHardDrives = eraseHardDrives;
    }

    protected boolean eraseHardDrivesSpecified;

    public boolean isEraseHardDrivesSpecified() {
        return eraseHardDrivesSpecified;
    }

    public void unsetEraseHardDrives() {
        eraseHardDrives = null;
        eraseHardDrivesSpecified = false;
    }

    /**
     * The hard drive partitions that a server can be partitioned with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List hardDrives;

    public List getHardDrives() {
        if (hardDrives == null) {
            hardDrives = new ArrayList();
        }
        return hardDrives;
    }

    protected boolean hardDrivesSpecified;

    public boolean isHardDrivesSpecified() {
        return hardDrivesSpecified;
    }

    public void unsetHardDrives() {
        hardDrives = null;
        hardDrivesSpecified = false;
    }

    /**
     * An Image Template ID [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] that will be deployed to the host.  If provided no item prices are required.
     */
    @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;
    }

    /**
     * The item prices that a server can be configured with.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List itemPrices;

    public List getItemPrices() {
        if (itemPrices == null) {
            itemPrices = new ArrayList();
        }
        return itemPrices;
    }

    protected boolean itemPricesSpecified;

    public boolean isItemPricesSpecified() {
        return itemPricesSpecified;
    }

    public void unsetItemPrices() {
        itemPrices = null;
        itemPricesSpecified = false;
    }

    /**
     * A flag indicating that the provision should use LVM for all logical drives.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long lvmFlag;

    public Long getLvmFlag() {
        return lvmFlag;
    }

    public void setLvmFlag(Long lvmFlag) {
        lvmFlagSpecified = true;
        this.lvmFlag = lvmFlag;
    }

    protected boolean lvmFlagSpecified;

    public boolean isLvmFlagSpecified() {
        return lvmFlagSpecified;
    }

    public void unsetLvmFlag() {
        lvmFlag = null;
        lvmFlagSpecified = false;
    }

    /**
     * A flag indicating that the remote management cards password will be reset.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long resetIpmiPassword;

    public Long getResetIpmiPassword() {
        return resetIpmiPassword;
    }

    public void setResetIpmiPassword(Long resetIpmiPassword) {
        resetIpmiPasswordSpecified = true;
        this.resetIpmiPassword = resetIpmiPassword;
    }

    protected boolean resetIpmiPasswordSpecified;

    public boolean isResetIpmiPasswordSpecified() {
        return resetIpmiPasswordSpecified;
    }

    public void unsetResetIpmiPassword() {
        resetIpmiPassword = null;
        resetIpmiPasswordSpecified = false;
    }

    /**
     * The token of the requesting service. Do not set.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String serviceToken;

    public String getServiceToken() {
        return serviceToken;
    }

    public void setServiceToken(String serviceToken) {
        serviceTokenSpecified = true;
        this.serviceToken = serviceToken;
    }

    protected boolean serviceTokenSpecified;

    public boolean isServiceTokenSpecified() {
        return serviceTokenSpecified;
    }

    public void unsetServiceToken() {
        serviceToken = null;
        serviceTokenSpecified = false;
    }

    /**
     * IDs to SoftLayer_Security_Ssh_Key objects on the current account which will be added to the server for authentication. SSH Keys will not be added to servers with Microsoft Windows. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List sshKeyIds;

    public List getSshKeyIds() {
        if (sshKeyIds == null) {
            sshKeyIds = new ArrayList();
        }
        return sshKeyIds;
    }

    protected boolean sshKeyIdsSpecified;

    public boolean isSshKeyIdsSpecified() {
        return sshKeyIdsSpecified;
    }

    public void unsetSshKeyIds() {
        sshKeyIds = null;
        sshKeyIdsSpecified = false;
    }

    /**
     * A flag indicating that the BIOS will be updated when installing the operating system.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long upgradeBios;

    public Long getUpgradeBios() {
        return upgradeBios;
    }

    public void setUpgradeBios(Long upgradeBios) {
        upgradeBiosSpecified = true;
        this.upgradeBios = upgradeBios;
    }

    protected boolean upgradeBiosSpecified;

    public boolean isUpgradeBiosSpecified() {
        return upgradeBiosSpecified;
    }

    public void unsetUpgradeBios() {
        upgradeBios = null;
        upgradeBiosSpecified = false;
    }

    /**
     * A flag indicating that the firmware on all hard drives will be updated when installing the operating system.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long upgradeHardDriveFirmware;

    public Long getUpgradeHardDriveFirmware() {
        return upgradeHardDriveFirmware;
    }

    public void setUpgradeHardDriveFirmware(Long upgradeHardDriveFirmware) {
        upgradeHardDriveFirmwareSpecified = true;
        this.upgradeHardDriveFirmware = upgradeHardDriveFirmware;
    }

    protected boolean upgradeHardDriveFirmwareSpecified;

    public boolean isUpgradeHardDriveFirmwareSpecified() {
        return upgradeHardDriveFirmwareSpecified;
    }

    public void unsetUpgradeHardDriveFirmware() {
        upgradeHardDriveFirmware = null;
        upgradeHardDriveFirmwareSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask addToSparePoolAfterOsReload() {
            withLocalProperty("addToSparePoolAfterOsReload");
            return this;
        }

        public Mask customProvisionScriptUri() {
            withLocalProperty("customProvisionScriptUri");
            return this;
        }

        public Mask driveRetentionFlag() {
            withLocalProperty("driveRetentionFlag");
            return this;
        }

        public Mask eraseHardDrives() {
            withLocalProperty("eraseHardDrives");
            return this;
        }

        public com.softlayer.api.service.hardware.Component.Mask hardDrives() {
            return withSubMask("hardDrives", com.softlayer.api.service.hardware.Component.Mask.class);
        }

        public Mask imageTemplateId() {
            withLocalProperty("imageTemplateId");
            return this;
        }

        public com.softlayer.api.service.product.item.Price.Mask itemPrices() {
            return withSubMask("itemPrices", com.softlayer.api.service.product.item.Price.Mask.class);
        }

        public Mask lvmFlag() {
            withLocalProperty("lvmFlag");
            return this;
        }

        public Mask resetIpmiPassword() {
            withLocalProperty("resetIpmiPassword");
            return this;
        }

        public Mask serviceToken() {
            withLocalProperty("serviceToken");
            return this;
        }

        public Mask sshKeyIds() {
            withLocalProperty("sshKeyIds");
            return this;
        }

        public Mask upgradeBios() {
            withLocalProperty("upgradeBios");
            return this;
        }

        public Mask upgradeHardDriveFirmware() {
            withLocalProperty("upgradeHardDriveFirmware");
            return this;
        }

    }

}