com.softlayer.api.service.software.Description

@ApiType("SoftLayer_Software_Description")
public class Description
extends Entity

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 Also:: SoftLayer_Software_Description

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class Description.Mask

static interface Description.Service

static interface Description.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected Long`	`attributeCount`	A count of
`protected List<Attribute>`	`attributes`
`protected Long`	`averageInstallationDuration`	The average amount of time that a software description takes to install.
`protected Long`	`compatibleSoftwareDescriptionCount`	A count of a list of the software descriptions that are compatible with this software description.
`protected List<Description>`	`compatibleSoftwareDescriptions`	A list of the software descriptions that are compatible with this software description.
`protected Long`	`controlPanel`	This is set to '1' if this Software Description describes a Control Panel.
`protected boolean`	`controlPanelSpecified`
`protected Long`	`featureCount`	A count of the feature attributes of a software description.
`protected List<Feature>`	`features`	The feature attributes of a software description.
`protected Long`	`id`	An ID number to identify this Software Description.
`protected boolean`	`idSpecified`
`protected List<Description>`	`latestVersion`	The latest version of a software description.
`protected Long`	`latestVersionCount`	A count of the latest version of a software description.
`protected String`	`licenseTermUnit`	The unit of measurement (day, month, or year) for license registration.
`protected boolean`	`licenseTermUnitSpecified`
`protected Long`	`licenseTermValue`	The number of units (licenseTermUnit) a new license is valid for at the time of registration.
`protected boolean`	`licenseTermValueSpecified`
`protected String`	`longDescription`	The manufacturer, name and version of a piece of software.
`protected boolean`	`longDescriptionSpecified`
`protected String`	`manufacturer`	The name of the manufacturer for this specific piece of software.
`protected boolean`	`manufacturerSpecified`
`protected String`	`name`	The name of this specific piece of software.
`protected boolean`	`nameSpecified`
`protected Long`	`operatingSystem`	This is set to '1' if this Software Description describes an Operating System.
`protected boolean`	`operatingSystemSpecified`
`protected Long`	`productItemCount`	A count of the various product items to which this software description is linked.
`protected List<Item>`	`productItems`	The various product items to which this software description is linked.
`protected Group`	`provisionTransactionGroup`	This details the provisioning transaction group for this software.
`protected String`	`referenceCode`	A reference code is structured as three tokens separated by underscores.
`protected boolean`	`referenceCodeSpecified`
`protected Group`	`reloadTransactionGroup`	The transaction group that a software description belongs to.
`protected String`	`requiredUser`	The default user created for a given a software description.
`protected Long`	`softwareLicenseCount`	A count of software Licenses that govern this Software Description.
`protected List<License>`	`softwareLicenses`	Software Licenses that govern this Software Description.
`protected Description`	`upgradeSoftwareDescription`	A suggestion for an upgrade path from this Software Description
`protected Long`	`upgradeSoftwareDescriptionId`	Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.
`protected boolean`	`upgradeSoftwareDescriptionIdSpecified`
`protected Description`	`upgradeSwDesc`	A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)
`protected Long`	`upgradeSwDescId`	Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.
`protected boolean`	`upgradeSwDescIdSpecified`
`protected Long`	`validFilesystemTypeCount`	A count of
`protected List<Type>`	`validFilesystemTypes`
`protected String`	`version`	The version of this specific piece of software.
`protected boolean`	`versionSpecified`
`protected Long`	`virtualizationPlatform`	This is set to '1' if this Software Description a platform for hosting virtual servers.
`protected boolean`	`virtualizationPlatformSpecified`
`protected Long`	`virtualLicense`	This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address).
`protected boolean`	`virtualLicenseSpecified`

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor Description

Description()

Method Summary

Modifier and Type	Method	Description
`Description.Service`	`asService(ApiClient client)`
`Long`	`getAttributeCount()`
`List<Attribute>`	`getAttributes()`
`Long`	`getAverageInstallationDuration()`
`Long`	`getCompatibleSoftwareDescriptionCount()`
`List<Description>`	`getCompatibleSoftwareDescriptions()`
`Long`	`getControlPanel()`
`Long`	`getFeatureCount()`
`List<Feature>`	`getFeatures()`
`Long`	`getId()`
`List<Description>`	`getLatestVersion()`
`Long`	`getLatestVersionCount()`
`String`	`getLicenseTermUnit()`
`Long`	`getLicenseTermValue()`
`String`	`getLongDescription()`
`String`	`getManufacturer()`
`String`	`getName()`
`Long`	`getOperatingSystem()`
`Long`	`getProductItemCount()`
`List<Item>`	`getProductItems()`
`Group`	`getProvisionTransactionGroup()`
`String`	`getReferenceCode()`
`Group`	`getReloadTransactionGroup()`
`String`	`getRequiredUser()`
`Long`	`getSoftwareLicenseCount()`
`List<License>`	`getSoftwareLicenses()`
`Description`	`getUpgradeSoftwareDescription()`
`Long`	`getUpgradeSoftwareDescriptionId()`
`Description`	`getUpgradeSwDesc()`
`Long`	`getUpgradeSwDescId()`
`Long`	`getValidFilesystemTypeCount()`
`List<Type>`	`getValidFilesystemTypes()`
`String`	`getVersion()`
`Long`	`getVirtualizationPlatform()`
`Long`	`getVirtualLicense()`
`boolean`	`isControlPanelSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isLicenseTermUnitSpecified()`
`boolean`	`isLicenseTermValueSpecified()`
`boolean`	`isLongDescriptionSpecified()`
`boolean`	`isManufacturerSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isOperatingSystemSpecified()`
`boolean`	`isReferenceCodeSpecified()`
`boolean`	`isUpgradeSoftwareDescriptionIdSpecified()`
`boolean`	`isUpgradeSwDescIdSpecified()`
`boolean`	`isVersionSpecified()`
`boolean`	`isVirtualizationPlatformSpecified()`
`boolean`	`isVirtualLicenseSpecified()`
`static Description.Service`	`service(ApiClient client)`
`static Description.Service`	`service(ApiClient client, Long id)`
`void`	`setAttributeCount(Long attributeCount)`
`void`	`setAverageInstallationDuration(Long averageInstallationDuration)`
`void`	`setCompatibleSoftwareDescriptionCount(Long compatibleSoftwareDescriptionCount)`
`void`	`setControlPanel(Long controlPanel)`
`void`	`setFeatureCount(Long featureCount)`
`void`	`setId(Long id)`
`void`	`setLatestVersionCount(Long latestVersionCount)`
`void`	`setLicenseTermUnit(String licenseTermUnit)`
`void`	`setLicenseTermValue(Long licenseTermValue)`
`void`	`setLongDescription(String longDescription)`
`void`	`setManufacturer(String manufacturer)`
`void`	`setName(String name)`
`void`	`setOperatingSystem(Long operatingSystem)`
`void`	`setProductItemCount(Long productItemCount)`
`void`	`setProvisionTransactionGroup(Group provisionTransactionGroup)`
`void`	`setReferenceCode(String referenceCode)`
`void`	`setReloadTransactionGroup(Group reloadTransactionGroup)`
`void`	`setRequiredUser(String requiredUser)`
`void`	`setSoftwareLicenseCount(Long softwareLicenseCount)`
`void`	`setUpgradeSoftwareDescription(Description upgradeSoftwareDescription)`
`void`	`setUpgradeSoftwareDescriptionId(Long upgradeSoftwareDescriptionId)`
`void`	`setUpgradeSwDesc(Description upgradeSwDesc)`
`void`	`setUpgradeSwDescId(Long upgradeSwDescId)`
`void`	`setValidFilesystemTypeCount(Long validFilesystemTypeCount)`
`void`	`setVersion(String version)`
`void`	`setVirtualizationPlatform(Long virtualizationPlatform)`
`void`	`setVirtualLicense(Long virtualLicense)`
`void`	`unsetControlPanel()`
`void`	`unsetId()`
`void`	`unsetLicenseTermUnit()`
`void`	`unsetLicenseTermValue()`
`void`	`unsetLongDescription()`
`void`	`unsetManufacturer()`
`void`	`unsetName()`
`void`	`unsetOperatingSystem()`
`void`	`unsetReferenceCode()`
`void`	`unsetUpgradeSoftwareDescriptionId()`
`void`	`unsetUpgradeSwDescId()`
`void`	`unsetVersion()`
`void`	`unsetVirtualizationPlatform()`
`void`	`unsetVirtualLicense()`

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- attributes
  
  @ApiProperty protected List<Attribute> attributes
- averageInstallationDuration
  
  @ApiProperty protected Long averageInstallationDuration
  
  The average amount of time that a software description takes to install.
- compatibleSoftwareDescriptions
  
  @ApiProperty protected List<Description> compatibleSoftwareDescriptions
  
  A list of the software descriptions that are compatible with this software description.
- features
  
  @ApiProperty protected List<Feature> features
  
  The feature attributes of a software description.
- latestVersion
  
  @ApiProperty protected List<Description> latestVersion
  
  The latest version of a software description.
- productItems
  
  @ApiProperty protected List<Item> productItems
  
  The various product items to which this software description is linked.
- provisionTransactionGroup
  
  @ApiProperty protected Group provisionTransactionGroup
  
  This details the provisioning transaction group for this software. This is only valid for Operating System software.
- reloadTransactionGroup
  
  @ApiProperty protected Group reloadTransactionGroup
  
  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.
- requiredUser
  
  @ApiProperty protected String requiredUser
  
  The default user created for a given a software description.
- softwareLicenses
  
  @ApiProperty protected List<License> softwareLicenses
  
  Software Licenses that govern this Software Description.
- upgradeSoftwareDescription
  
  @ApiProperty protected Description upgradeSoftwareDescription
  
  A suggestion for an upgrade path from this Software Description
- upgradeSwDesc
  
  @ApiProperty protected Description upgradeSwDesc
  
  A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)
- validFilesystemTypes
  
  @ApiProperty protected List<Type> validFilesystemTypes
- controlPanel
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long controlPanel
  
  This is set to '1' if this Software Description describes a Control Panel.
- controlPanelSpecified
  
  protected boolean controlPanelSpecified
- id
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long id
  
  An ID number to identify this Software Description.
- idSpecified
  
  protected boolean idSpecified
- licenseTermUnit
  
  @ApiProperty(canBeNullOrNotSet=true) protected String licenseTermUnit
  
  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.
- licenseTermUnitSpecified
  
  protected boolean licenseTermUnitSpecified
- licenseTermValue
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long licenseTermValue
  
  The number of units (licenseTermUnit) a new license is valid for at the time of registration.
- licenseTermValueSpecified
  
  protected boolean licenseTermValueSpecified
- longDescription
  
  @ApiProperty(canBeNullOrNotSet=true) protected String longDescription
  
  The manufacturer, name and version of a piece of software.
- longDescriptionSpecified
  
  protected boolean longDescriptionSpecified
- manufacturer
  
  @ApiProperty(canBeNullOrNotSet=true) protected String manufacturer
  
  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.
- manufacturerSpecified
  
  protected boolean manufacturerSpecified
- name
  
  @ApiProperty(canBeNullOrNotSet=true) protected String name
  
  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.
- nameSpecified
  
  protected boolean nameSpecified
- operatingSystem
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long operatingSystem
  
  This is set to '1' if this Software Description describes an Operating System.
- operatingSystemSpecified
  
  protected boolean operatingSystemSpecified
- referenceCode
  
  @ApiProperty(canBeNullOrNotSet=true) protected String referenceCode
  
  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.
- referenceCodeSpecified
  
  protected boolean referenceCodeSpecified
- upgradeSoftwareDescriptionId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long upgradeSoftwareDescriptionId
  
  Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation.
- upgradeSoftwareDescriptionIdSpecified
  
  protected boolean upgradeSoftwareDescriptionIdSpecified
- upgradeSwDescId
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long upgradeSwDescId
  
  Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. (Deprecated - Use upgradeSoftwareDescriptionId)
- upgradeSwDescIdSpecified
  
  protected boolean upgradeSwDescIdSpecified
- version
  
  @ApiProperty(canBeNullOrNotSet=true) protected String version
  
  The version of this specific piece of software.
- versionSpecified
  
  protected boolean versionSpecified
- virtualLicense
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long virtualLicense
  
  This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address).
- virtualLicenseSpecified
  
  protected boolean virtualLicenseSpecified
- virtualizationPlatform
  
  @ApiProperty(canBeNullOrNotSet=true) protected Long virtualizationPlatform
  
  This is set to '1' if this Software Description a platform for hosting virtual servers.
- virtualizationPlatformSpecified
  
  protected boolean virtualizationPlatformSpecified
- attributeCount
  
  @ApiProperty protected Long attributeCount
  
  A count of
- compatibleSoftwareDescriptionCount
  
  @ApiProperty protected Long compatibleSoftwareDescriptionCount
  
  A count of a list of the software descriptions that are compatible with this software description.
- featureCount
  
  @ApiProperty protected Long featureCount
  
  A count of the feature attributes of a software description.
- latestVersionCount
  
  @ApiProperty protected Long latestVersionCount
  
  A count of the latest version of a software description.
- productItemCount
  
  @ApiProperty protected Long productItemCount
  
  A count of the various product items to which this software description is linked.
- softwareLicenseCount
  
  @ApiProperty protected Long softwareLicenseCount
  
  A count of software Licenses that govern this Software Description.
- validFilesystemTypeCount
  
  @ApiProperty protected Long validFilesystemTypeCount
  
  A count of
Constructor Details
- Description
  
  public Description()
Method Details
- getAttributes
  
  public List<Attribute> getAttributes()
- getAverageInstallationDuration
  
  public Long getAverageInstallationDuration()
- setAverageInstallationDuration
  
  public void setAverageInstallationDuration(Long averageInstallationDuration)
- getCompatibleSoftwareDescriptions
  
  public List<Description> getCompatibleSoftwareDescriptions()
- getFeatures
  
  public List<Feature> getFeatures()
- getLatestVersion
  
  public List<Description> getLatestVersion()
- getProductItems
  
  public List<Item> getProductItems()
- getProvisionTransactionGroup
  
  public Group getProvisionTransactionGroup()
- setProvisionTransactionGroup
  
  public void setProvisionTransactionGroup(Group provisionTransactionGroup)
- getReloadTransactionGroup
  
  public Group getReloadTransactionGroup()
- setReloadTransactionGroup
  
  public void setReloadTransactionGroup(Group reloadTransactionGroup)
- getRequiredUser
  
  public String getRequiredUser()
- setRequiredUser
  
  public void setRequiredUser(String requiredUser)
- getSoftwareLicenses
  
  public List<License> getSoftwareLicenses()
- getUpgradeSoftwareDescription
  
  public Description getUpgradeSoftwareDescription()
- setUpgradeSoftwareDescription
  
  public void setUpgradeSoftwareDescription(Description upgradeSoftwareDescription)
- getUpgradeSwDesc
  
  public Description getUpgradeSwDesc()
- setUpgradeSwDesc
  
  public void setUpgradeSwDesc(Description upgradeSwDesc)
- getValidFilesystemTypes
  
  public List<Type> getValidFilesystemTypes()
- getControlPanel
  
  public Long getControlPanel()
- setControlPanel
  
  public void setControlPanel(Long controlPanel)
- isControlPanelSpecified
  
  public boolean isControlPanelSpecified()
- unsetControlPanel
  
  public void unsetControlPanel()
- getId
  
  public Long getId()
- setId
  
  public void setId(Long id)
- isIdSpecified
  
  public boolean isIdSpecified()
- unsetId
  
  public void unsetId()
- getLicenseTermUnit
  
  public String getLicenseTermUnit()
- setLicenseTermUnit
  
  public void setLicenseTermUnit(String licenseTermUnit)
- isLicenseTermUnitSpecified
  
  public boolean isLicenseTermUnitSpecified()
- unsetLicenseTermUnit
  
  public void unsetLicenseTermUnit()
- getLicenseTermValue
  
  public Long getLicenseTermValue()
- setLicenseTermValue
  
  public void setLicenseTermValue(Long licenseTermValue)
- isLicenseTermValueSpecified
  
  public boolean isLicenseTermValueSpecified()
- unsetLicenseTermValue
  
  public void unsetLicenseTermValue()
- getLongDescription
  
  public String getLongDescription()
- setLongDescription
  
  public void setLongDescription(String longDescription)
- isLongDescriptionSpecified
  
  public boolean isLongDescriptionSpecified()
- unsetLongDescription
  
  public void unsetLongDescription()
- getManufacturer
  
  public String getManufacturer()
- setManufacturer
  
  public void setManufacturer(String manufacturer)
- isManufacturerSpecified
  
  public boolean isManufacturerSpecified()
- unsetManufacturer
  
  public void unsetManufacturer()
- getName
  
  public String getName()
- setName
  
  public void setName(String name)
- isNameSpecified
  
  public boolean isNameSpecified()
- unsetName
  
  public void unsetName()
- getOperatingSystem
  
  public Long getOperatingSystem()
- setOperatingSystem
  
  public void setOperatingSystem(Long operatingSystem)
- isOperatingSystemSpecified
  
  public boolean isOperatingSystemSpecified()
- unsetOperatingSystem
  
  public void unsetOperatingSystem()
- getReferenceCode
  
  public String getReferenceCode()
- setReferenceCode
  
  public void setReferenceCode(String referenceCode)
- isReferenceCodeSpecified
  
  public boolean isReferenceCodeSpecified()
- unsetReferenceCode
  
  public void unsetReferenceCode()
- getUpgradeSoftwareDescriptionId
  
  public Long getUpgradeSoftwareDescriptionId()
- setUpgradeSoftwareDescriptionId
  
  public void setUpgradeSoftwareDescriptionId(Long upgradeSoftwareDescriptionId)
- isUpgradeSoftwareDescriptionIdSpecified
  
  public boolean isUpgradeSoftwareDescriptionIdSpecified()
- unsetUpgradeSoftwareDescriptionId
  
  public void unsetUpgradeSoftwareDescriptionId()
- getUpgradeSwDescId
  
  public Long getUpgradeSwDescId()
- setUpgradeSwDescId
  
  public void setUpgradeSwDescId(Long upgradeSwDescId)
- isUpgradeSwDescIdSpecified
  
  public boolean isUpgradeSwDescIdSpecified()
- unsetUpgradeSwDescId
  
  public void unsetUpgradeSwDescId()
- getVersion
  
  public String getVersion()
- setVersion
  
  public void setVersion(String version)
- isVersionSpecified
  
  public boolean isVersionSpecified()
- unsetVersion
  
  public void unsetVersion()
- getVirtualLicense
  
  public Long getVirtualLicense()
- setVirtualLicense
  
  public void setVirtualLicense(Long virtualLicense)
- isVirtualLicenseSpecified
  
  public boolean isVirtualLicenseSpecified()
- unsetVirtualLicense
  
  public void unsetVirtualLicense()
- getVirtualizationPlatform
  
  public Long getVirtualizationPlatform()
- setVirtualizationPlatform
  
  public void setVirtualizationPlatform(Long virtualizationPlatform)
- isVirtualizationPlatformSpecified
  
  public boolean isVirtualizationPlatformSpecified()
- unsetVirtualizationPlatform
  
  public void unsetVirtualizationPlatform()
- getAttributeCount
  
  public Long getAttributeCount()
- setAttributeCount
  
  public void setAttributeCount(Long attributeCount)
- getCompatibleSoftwareDescriptionCount
  
  public Long getCompatibleSoftwareDescriptionCount()
- setCompatibleSoftwareDescriptionCount
  
  public void setCompatibleSoftwareDescriptionCount(Long compatibleSoftwareDescriptionCount)
- getFeatureCount
  
  public Long getFeatureCount()
- setFeatureCount
  
  public void setFeatureCount(Long featureCount)
- getLatestVersionCount
  
  public Long getLatestVersionCount()
- setLatestVersionCount
  
  public void setLatestVersionCount(Long latestVersionCount)
- getProductItemCount
  
  public Long getProductItemCount()
- setProductItemCount
  
  public void setProductItemCount(Long productItemCount)
- getSoftwareLicenseCount
  
  public Long getSoftwareLicenseCount()
- setSoftwareLicenseCount
  
  public void setSoftwareLicenseCount(Long softwareLicenseCount)
- getValidFilesystemTypeCount
  
  public Long getValidFilesystemTypeCount()
- setValidFilesystemTypeCount
  
  public void setValidFilesystemTypeCount(Long validFilesystemTypeCount)
- asService
  
  public Description.Service asService(ApiClient client)
- service
  
  public static Description.Service service(ApiClient client)
- service
  
  public static Description.Service service(ApiClient client, Long id)

Modifier and Type	Class	Description
`static class`	`Description.Mask`
`static interface`	`Description.Service`
`static interface`	`Description.ServiceAsync`

Class Description

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details