com.softlayer.api.service.software.Description 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.software;

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.Entity;
import com.softlayer.api.service.configuration.storage.filesystem.Type;
import com.softlayer.api.service.product.Item;
import com.softlayer.api.service.provisioning.version1.transaction.Group;
import com.softlayer.api.service.software.License;
import com.softlayer.api.service.software.description.Attribute;
import com.softlayer.api.service.software.description.Feature;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Future;

/**
 * This class holds a description for a specific installation of a Software Component. 

 * 

 * SoftLayer_Software_Licenses tie a Software Component (A specific installation on a piece of hardware) to it's description. 

 * 

 * The "Manufacturer" and "Name" properties of a SoftLayer_Software_Description are used by the framework to factory specific objects, objects that may have special methods for that specific piece of software, or objects that contain application specific data, such as default ports.  For example, if you create a SoftLayer_Software_Component who's SoftLayer_Software_License points to the SoftLayer_Software_Description for "Swsoft" "Plesk", you'll actually get a SoftLayer_Software_Component_Swsoft_Plesk object. 
 *
 * @see SoftLayer_Software_Description
 */
@ApiType("SoftLayer_Software_Description")
public class Description extends Entity {

    @ApiProperty
    protected List attributes;

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

    /**
     * The average amount of time that a software description takes to install.
     */
    @ApiProperty
    protected Long averageInstallationDuration;

    public Long getAverageInstallationDuration() {
        return averageInstallationDuration;
    }

    public void setAverageInstallationDuration(Long averageInstallationDuration) {
        this.averageInstallationDuration = averageInstallationDuration;
    }

    /**
     * A list of the software descriptions that are compatible with this software description.
     */
    @ApiProperty
    protected List compatibleSoftwareDescriptions;

    public List getCompatibleSoftwareDescriptions() {
        if (compatibleSoftwareDescriptions == null) {
            compatibleSoftwareDescriptions = new ArrayList();
        }
        return compatibleSoftwareDescriptions;
    }

    /**
     * The feature attributes of a software description.
     */
    @ApiProperty
    protected List features;

    public List getFeatures() {
        if (features == null) {
            features = new ArrayList();
        }
        return features;
    }

    /**
     * The latest version of a software description.
     */
    @ApiProperty
    protected List latestVersion;

    public List getLatestVersion() {
        if (latestVersion == null) {
            latestVersion = new ArrayList();
        }
        return latestVersion;
    }

    /**
     * The various product items to which this software description is linked.
     */
    @ApiProperty
    protected List productItems;

    public List getProductItems() {
        if (productItems == null) {
            productItems = new ArrayList();
        }
        return productItems;
    }

    /**
     * This details the provisioning transaction group for this software. This is only valid for Operating System software.
     */
    @ApiProperty
    protected Group provisionTransactionGroup;

    public Group getProvisionTransactionGroup() {
        return provisionTransactionGroup;
    }

    public void setProvisionTransactionGroup(Group provisionTransactionGroup) {
        this.provisionTransactionGroup = provisionTransactionGroup;
    }

    /**
     * The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software.
     */
    @ApiProperty
    protected Group reloadTransactionGroup;

    public Group getReloadTransactionGroup() {
        return reloadTransactionGroup;
    }

    public void setReloadTransactionGroup(Group reloadTransactionGroup) {
        this.reloadTransactionGroup = reloadTransactionGroup;
    }

    /**
     * The default user created for a given a software description.
     */
    @ApiProperty
    protected String requiredUser;

    public String getRequiredUser() {
        return requiredUser;
    }

    public void setRequiredUser(String requiredUser) {
        this.requiredUser = requiredUser;
    }

    /**
     * Software Licenses that govern this Software Description.
     */
    @ApiProperty
    protected List softwareLicenses;

    public List getSoftwareLicenses() {
        if (softwareLicenses == null) {
            softwareLicenses = new ArrayList();
        }
        return softwareLicenses;
    }

    /**
     * A suggestion for an upgrade path from this Software Description
     */
    @ApiProperty
    protected Description upgradeSoftwareDescription;

    public Description getUpgradeSoftwareDescription() {
        return upgradeSoftwareDescription;
    }

    public void setUpgradeSoftwareDescription(Description upgradeSoftwareDescription) {
        this.upgradeSoftwareDescription = upgradeSoftwareDescription;
    }

    /**
     * A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)
     */
    @ApiProperty
    protected Description upgradeSwDesc;

    public Description getUpgradeSwDesc() {
        return upgradeSwDesc;
    }

    public void setUpgradeSwDesc(Description upgradeSwDesc) {
        this.upgradeSwDesc = upgradeSwDesc;
    }

    @ApiProperty
    protected List validFilesystemTypes;

    public List getValidFilesystemTypes() {
        if (validFilesystemTypes == null) {
            validFilesystemTypes = new ArrayList();
        }
        return validFilesystemTypes;
    }

    /**
     * This is set to '1' if this Software Description describes a Control Panel.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long controlPanel;

    public Long getControlPanel() {
        return controlPanel;
    }

    public void setControlPanel(Long controlPanel) {
        controlPanelSpecified = true;
        this.controlPanel = controlPanel;
    }

    protected boolean controlPanelSpecified;

    public boolean isControlPanelSpecified() {
        return controlPanelSpecified;
    }

    public void unsetControlPanel() {
        controlPanel = null;
        controlPanelSpecified = false;
    }

    /**
     * An ID number to identify this Software Description.
     */
    @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;
    }

    /**
     * The unit of measurement (day, month, or year) for license registration. Used in conjunction with licenseTermValue to determine overall license registration length of a new license. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String licenseTermUnit;

    public String getLicenseTermUnit() {
        return licenseTermUnit;
    }

    public void setLicenseTermUnit(String licenseTermUnit) {
        licenseTermUnitSpecified = true;
        this.licenseTermUnit = licenseTermUnit;
    }

    protected boolean licenseTermUnitSpecified;

    public boolean isLicenseTermUnitSpecified() {
        return licenseTermUnitSpecified;
    }

    public void unsetLicenseTermUnit() {
        licenseTermUnit = null;
        licenseTermUnitSpecified = false;
    }

    /**
     * The number of units (licenseTermUnit) a new license is valid for at the time of registration.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long licenseTermValue;

    public Long getLicenseTermValue() {
        return licenseTermValue;
    }

    public void setLicenseTermValue(Long licenseTermValue) {
        licenseTermValueSpecified = true;
        this.licenseTermValue = licenseTermValue;
    }

    protected boolean licenseTermValueSpecified;

    public boolean isLicenseTermValueSpecified() {
        return licenseTermValueSpecified;
    }

    public void unsetLicenseTermValue() {
        licenseTermValue = null;
        licenseTermValueSpecified = false;
    }

    /**
     * The manufacturer, name and version of a piece of software.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String longDescription;

    public String getLongDescription() {
        return longDescription;
    }

    public void setLongDescription(String longDescription) {
        longDescriptionSpecified = true;
        this.longDescription = longDescription;
    }

    protected boolean longDescriptionSpecified;

    public boolean isLongDescriptionSpecified() {
        return longDescriptionSpecified;
    }

    public void unsetLongDescription() {
        longDescription = null;
        longDescriptionSpecified = false;
    }

    /**
     * The name of the manufacturer for this specific piece of software.  This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String manufacturer;

    public String getManufacturer() {
        return manufacturer;
    }

    public void setManufacturer(String manufacturer) {
        manufacturerSpecified = true;
        this.manufacturer = manufacturer;
    }

    protected boolean manufacturerSpecified;

    public boolean isManufacturerSpecified() {
        return manufacturerSpecified;
    }

    public void unsetManufacturer() {
        manufacturer = null;
        manufacturerSpecified = false;
    }

    /**
     * The name of this specific piece of software.  This name is used by SoftLayer_Software_Component to tailor make (factory) specific types of Software Components that know details like default ports. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        nameSpecified = true;
        this.name = name;
    }

    protected boolean nameSpecified;

    public boolean isNameSpecified() {
        return nameSpecified;
    }

    public void unsetName() {
        name = null;
        nameSpecified = false;
    }

    /**
     * This is set to '1' if this Software Description describes an Operating System.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long operatingSystem;

    public Long getOperatingSystem() {
        return operatingSystem;
    }

    public void setOperatingSystem(Long operatingSystem) {
        operatingSystemSpecified = true;
        this.operatingSystem = operatingSystem;
    }

    protected boolean operatingSystemSpecified;

    public boolean isOperatingSystemSpecified() {
        return operatingSystemSpecified;
    }

    public void unsetOperatingSystem() {
        operatingSystem = null;
        operatingSystemSpecified = false;
    }

    /**
     * A reference code is structured as three tokens separated by underscores. The first token represents the product, the second is the version of the product, and the third is whether the software is 32 or 64bit. 
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String referenceCode;

    public String getReferenceCode() {
        return referenceCode;
    }

    public void setReferenceCode(String referenceCode) {
        referenceCodeSpecified = true;
        this.referenceCode = referenceCode;
    }

    protected boolean referenceCodeSpecified;

    public boolean isReferenceCodeSpecified() {
        return referenceCodeSpecified;
    }

    public void unsetReferenceCode() {
        referenceCode = null;
        referenceCodeSpecified = false;
    }

    /**
     * Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long upgradeSoftwareDescriptionId;

    public Long getUpgradeSoftwareDescriptionId() {
        return upgradeSoftwareDescriptionId;
    }

    public void setUpgradeSoftwareDescriptionId(Long upgradeSoftwareDescriptionId) {
        upgradeSoftwareDescriptionIdSpecified = true;
        this.upgradeSoftwareDescriptionId = upgradeSoftwareDescriptionId;
    }

    protected boolean upgradeSoftwareDescriptionIdSpecified;

    public boolean isUpgradeSoftwareDescriptionIdSpecified() {
        return upgradeSoftwareDescriptionIdSpecified;
    }

    public void unsetUpgradeSoftwareDescriptionId() {
        upgradeSoftwareDescriptionId = null;
        upgradeSoftwareDescriptionIdSpecified = false;
    }

    /**
     * Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. (Deprecated - Use upgradeSoftwareDescriptionId)
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long upgradeSwDescId;

    public Long getUpgradeSwDescId() {
        return upgradeSwDescId;
    }

    public void setUpgradeSwDescId(Long upgradeSwDescId) {
        upgradeSwDescIdSpecified = true;
        this.upgradeSwDescId = upgradeSwDescId;
    }

    protected boolean upgradeSwDescIdSpecified;

    public boolean isUpgradeSwDescIdSpecified() {
        return upgradeSwDescIdSpecified;
    }

    public void unsetUpgradeSwDescId() {
        upgradeSwDescId = null;
        upgradeSwDescIdSpecified = false;
    }

    /**
     * The version of this specific piece of software.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String version;

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        versionSpecified = true;
        this.version = version;
    }

    protected boolean versionSpecified;

    public boolean isVersionSpecified() {
        return versionSpecified;
    }

    public void unsetVersion() {
        version = null;
        versionSpecified = false;
    }

    /**
     * This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address).
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long virtualLicense;

    public Long getVirtualLicense() {
        return virtualLicense;
    }

    public void setVirtualLicense(Long virtualLicense) {
        virtualLicenseSpecified = true;
        this.virtualLicense = virtualLicense;
    }

    protected boolean virtualLicenseSpecified;

    public boolean isVirtualLicenseSpecified() {
        return virtualLicenseSpecified;
    }

    public void unsetVirtualLicense() {
        virtualLicense = null;
        virtualLicenseSpecified = false;
    }

    /**
     * This is set to '1' if this Software Description a platform for hosting virtual servers.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long virtualizationPlatform;

    public Long getVirtualizationPlatform() {
        return virtualizationPlatform;
    }

    public void setVirtualizationPlatform(Long virtualizationPlatform) {
        virtualizationPlatformSpecified = true;
        this.virtualizationPlatform = virtualizationPlatform;
    }

    protected boolean virtualizationPlatformSpecified;

    public boolean isVirtualizationPlatformSpecified() {
        return virtualizationPlatformSpecified;
    }

    public void unsetVirtualizationPlatform() {
        virtualizationPlatform = null;
        virtualizationPlatformSpecified = false;
    }

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

    public Long getAttributeCount() {
        return attributeCount;
    }

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

    /**
     * A count of a list of the software descriptions that are compatible with this software description.
     */
    @ApiProperty
    protected Long compatibleSoftwareDescriptionCount;

    public Long getCompatibleSoftwareDescriptionCount() {
        return compatibleSoftwareDescriptionCount;
    }

    public void setCompatibleSoftwareDescriptionCount(Long compatibleSoftwareDescriptionCount) {
        this.compatibleSoftwareDescriptionCount = compatibleSoftwareDescriptionCount;
    }

    /**
     * A count of the feature attributes of a software description.
     */
    @ApiProperty
    protected Long featureCount;

    public Long getFeatureCount() {
        return featureCount;
    }

    public void setFeatureCount(Long featureCount) {
        this.featureCount = featureCount;
    }

    /**
     * A count of the latest version of a software description.
     */
    @ApiProperty
    protected Long latestVersionCount;

    public Long getLatestVersionCount() {
        return latestVersionCount;
    }

    public void setLatestVersionCount(Long latestVersionCount) {
        this.latestVersionCount = latestVersionCount;
    }

    /**
     * A count of the various product items to which this software description is linked.
     */
    @ApiProperty
    protected Long productItemCount;

    public Long getProductItemCount() {
        return productItemCount;
    }

    public void setProductItemCount(Long productItemCount) {
        this.productItemCount = productItemCount;
    }

    /**
     * A count of software Licenses that govern this Software Description.
     */
    @ApiProperty
    protected Long softwareLicenseCount;

    public Long getSoftwareLicenseCount() {
        return softwareLicenseCount;
    }

    public void setSoftwareLicenseCount(Long softwareLicenseCount) {
        this.softwareLicenseCount = softwareLicenseCount;
    }

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

    public Long getValidFilesystemTypeCount() {
        return validFilesystemTypeCount;
    }

    public void setValidFilesystemTypeCount(Long validFilesystemTypeCount) {
        this.validFilesystemTypeCount = validFilesystemTypeCount;
    }

    public Service asService(ApiClient client) {
        return service(client, id);
    }

    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());
    }

    /**
     * @see SoftLayer_Software_Description
     */
    @com.softlayer.api.annotation.ApiService("SoftLayer_Software_Description")
    public static interface Service extends com.softlayer.api.Service {

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

        /**
         * @see SoftLayer_Software_Description::getAllObjects
         */
        @ApiMethod
        public List getAllObjects();

        /**
         * @see SoftLayer_Software_Description::getCustomerOwnedLicenseDescriptions
         */
        @ApiMethod
        public List getCustomerOwnedLicenseDescriptions();

        /**
         * @see SoftLayer_Software_Description::getObject
         */
        @ApiMethod(instanceRequired = true)
        public Description getObject();

        /**
         * @see SoftLayer_Software_Description::getAttributes
         */
        @ApiMethod(instanceRequired = true)
        public List getAttributes();

        /**
         * The average amount of time that a software description takes to install.
         *
         * @see SoftLayer_Software_Description::getAverageInstallationDuration
         */
        @ApiMethod(instanceRequired = true)
        public Long getAverageInstallationDuration();

        /**
         * A list of the software descriptions that are compatible with this software description.
         *
         * @see SoftLayer_Software_Description::getCompatibleSoftwareDescriptions
         */
        @ApiMethod(instanceRequired = true)
        public List getCompatibleSoftwareDescriptions();

        /**
         * The feature attributes of a software description.
         *
         * @see SoftLayer_Software_Description::getFeatures
         */
        @ApiMethod(instanceRequired = true)
        public List getFeatures();

        /**
         * The latest version of a software description.
         *
         * @see SoftLayer_Software_Description::getLatestVersion
         */
        @ApiMethod(instanceRequired = true)
        public List getLatestVersion();

        /**
         * The various product items to which this software description is linked.
         *
         * @see SoftLayer_Software_Description::getProductItems
         */
        @ApiMethod(instanceRequired = true)
        public List getProductItems();

        /**
         * This details the provisioning transaction group for this software. This is only valid for Operating System software.
         *
         * @see SoftLayer_Software_Description::getProvisionTransactionGroup
         */
        @ApiMethod(instanceRequired = true)
        public Group getProvisionTransactionGroup();

        /**
         * The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software.
         *
         * @see SoftLayer_Software_Description::getReloadTransactionGroup
         */
        @ApiMethod(instanceRequired = true)
        public Group getReloadTransactionGroup();

        /**
         * The default user created for a given a software description.
         *
         * @see SoftLayer_Software_Description::getRequiredUser
         */
        @ApiMethod(instanceRequired = true)
        public String getRequiredUser();

        /**
         * Software Licenses that govern this Software Description.
         *
         * @see SoftLayer_Software_Description::getSoftwareLicenses
         */
        @ApiMethod(instanceRequired = true)
        public List getSoftwareLicenses();

        /**
         * A suggestion for an upgrade path from this Software Description
         *
         * @see SoftLayer_Software_Description::getUpgradeSoftwareDescription
         */
        @ApiMethod(instanceRequired = true)
        public Description getUpgradeSoftwareDescription();

        /**
         * A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)
         *
         * @see SoftLayer_Software_Description::getUpgradeSwDesc
         */
        @ApiMethod(instanceRequired = true)
        public Description getUpgradeSwDesc();

        /**
         * @see SoftLayer_Software_Description::getValidFilesystemTypes
         */
        @ApiMethod(instanceRequired = true)
        public List getValidFilesystemTypes();

    }

    public static interface ServiceAsync extends com.softlayer.api.ServiceAsync {

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

        /**
         * Async version of {@link Service#getAllObjects}
         */
        public Future> getAllObjects();

        public Future getAllObjects(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getCustomerOwnedLicenseDescriptions}
         */
        public Future> getCustomerOwnedLicenseDescriptions();

        public Future getCustomerOwnedLicenseDescriptions(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getObject}
         */
        public Future getObject();

        public Future getObject(ResponseHandler callback);

        /**
         * Async version of {@link Service#getAttributes}
         */
        public Future> getAttributes();

        /**
         * Async callback version of {@link Service#getAttributes}
         */
        public Future getAttributes(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getAverageInstallationDuration}
         */
        public Future getAverageInstallationDuration();

        /**
         * Async callback version of {@link Service#getAverageInstallationDuration}
         */
        public Future getAverageInstallationDuration(ResponseHandler callback);

        /**
         * Async version of {@link Service#getCompatibleSoftwareDescriptions}
         */
        public Future> getCompatibleSoftwareDescriptions();

        /**
         * Async callback version of {@link Service#getCompatibleSoftwareDescriptions}
         */
        public Future getCompatibleSoftwareDescriptions(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getFeatures}
         */
        public Future> getFeatures();

        /**
         * Async callback version of {@link Service#getFeatures}
         */
        public Future getFeatures(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getLatestVersion}
         */
        public Future> getLatestVersion();

        /**
         * Async callback version of {@link Service#getLatestVersion}
         */
        public Future getLatestVersion(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getProductItems}
         */
        public Future> getProductItems();

        /**
         * Async callback version of {@link Service#getProductItems}
         */
        public Future getProductItems(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getProvisionTransactionGroup}
         */
        public Future getProvisionTransactionGroup();

        /**
         * Async callback version of {@link Service#getProvisionTransactionGroup}
         */
        public Future getProvisionTransactionGroup(ResponseHandler callback);

        /**
         * Async version of {@link Service#getReloadTransactionGroup}
         */
        public Future getReloadTransactionGroup();

        /**
         * Async callback version of {@link Service#getReloadTransactionGroup}
         */
        public Future getReloadTransactionGroup(ResponseHandler callback);

        /**
         * Async version of {@link Service#getRequiredUser}
         */
        public Future getRequiredUser();

        /**
         * Async callback version of {@link Service#getRequiredUser}
         */
        public Future getRequiredUser(ResponseHandler callback);

        /**
         * Async version of {@link Service#getSoftwareLicenses}
         */
        public Future> getSoftwareLicenses();

        /**
         * Async callback version of {@link Service#getSoftwareLicenses}
         */
        public Future getSoftwareLicenses(ResponseHandler> callback);

        /**
         * Async version of {@link Service#getUpgradeSoftwareDescription}
         */
        public Future getUpgradeSoftwareDescription();

        /**
         * Async callback version of {@link Service#getUpgradeSoftwareDescription}
         */
        public Future getUpgradeSoftwareDescription(ResponseHandler callback);

        /**
         * Async version of {@link Service#getUpgradeSwDesc}
         */
        public Future getUpgradeSwDesc();

        /**
         * Async callback version of {@link Service#getUpgradeSwDesc}
         */
        public Future getUpgradeSwDesc(ResponseHandler callback);

        /**
         * Async version of {@link Service#getValidFilesystemTypes}
         */
        public Future> getValidFilesystemTypes();

        /**
         * Async callback version of {@link Service#getValidFilesystemTypes}
         */
        public Future getValidFilesystemTypes(ResponseHandler> callback);

    }

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

        public com.softlayer.api.service.software.description.Attribute.Mask attributes() {
            return withSubMask("attributes", com.softlayer.api.service.software.description.Attribute.Mask.class);
        }

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

        public Description.Mask compatibleSoftwareDescriptions() {
            return withSubMask("compatibleSoftwareDescriptions", Description.Mask.class);
        }

        public com.softlayer.api.service.software.description.Feature.Mask features() {
            return withSubMask("features", com.softlayer.api.service.software.description.Feature.Mask.class);
        }

        public Description.Mask latestVersion() {
            return withSubMask("latestVersion", Description.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask productItems() {
            return withSubMask("productItems", com.softlayer.api.service.product.Item.Mask.class);
        }

        public com.softlayer.api.service.provisioning.version1.transaction.Group.Mask provisionTransactionGroup() {
            return withSubMask("provisionTransactionGroup", com.softlayer.api.service.provisioning.version1.transaction.Group.Mask.class);
        }

        public com.softlayer.api.service.provisioning.version1.transaction.Group.Mask reloadTransactionGroup() {
            return withSubMask("reloadTransactionGroup", com.softlayer.api.service.provisioning.version1.transaction.Group.Mask.class);
        }

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

        public License.Mask softwareLicenses() {
            return withSubMask("softwareLicenses", License.Mask.class);
        }

        public Description.Mask upgradeSoftwareDescription() {
            return withSubMask("upgradeSoftwareDescription", Description.Mask.class);
        }

        public Description.Mask upgradeSwDesc() {
            return withSubMask("upgradeSwDesc", Description.Mask.class);
        }

        public com.softlayer.api.service.configuration.storage.filesystem.Type.Mask validFilesystemTypes() {
            return withSubMask("validFilesystemTypes", com.softlayer.api.service.configuration.storage.filesystem.Type.Mask.class);
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

}