Class Package
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.product.Package
@ApiType("SoftLayer_Product_Package") public class Package extends Entity
The SoftLayer_Product_Package data type contains information about packages from which orders can be generated. Packages contain general information regarding what is in them, where they are currently sold, availability, and pricing.
- See Also:
- SoftLayer_Product_Package
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Package.Mask
static interface
Package.Service
Every SoftLayer_Product_Package contains information related products and services that SoftLayer sells.static interface
Package.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Long
accountRestrictedActivePresetCount
A count of the preset configurations available only for the authenticated account and this package.protected List<Preset>
accountRestrictedActivePresets
The preset configurations available only for the authenticated account and this package.protected List<Category>
accountRestrictedCategories
The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices.protected Long
accountRestrictedCategoryCount
A count of the results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices.protected Boolean
accountRestrictedPricesFlag
The flag to indicate if there are any restricted prices in a package for the currently-active account.protected Long
activePresetCount
A count of the available preset configurations for this package.protected List<Preset>
activePresets
The available preset configurations for this package.protected Long
activeRamItemCount
A count of a collection of valid RAM items available for purchase in this package.protected List<Item>
activeRamItems
A collection of valid RAM items available for purchase in this package.protected Long
activeServerItemCount
A count of a collection of valid server items available for purchase in this package.protected List<Item>
activeServerItems
A collection of valid server items available for purchase in this package.protected Long
activeSoftwareItemCount
A count of a collection of valid software items available for purchase in this package.protected List<Item>
activeSoftwareItems
A collection of valid software items available for purchase in this package.protected Long
activeUsagePriceCount
A count of a collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.protected List<Price>
activeUsagePrices
A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.protected Boolean
additionalServiceFlag
This flag indicates that the package is an additional service.protected Long
attributeCount
A count ofprotected List<Attribute>
attributes
protected Long
availableLocationCount
A count of a collection of valid locations for this package.protected List<Locations>
availableLocations
A collection of valid locations for this package.protected Long
availableStorageUnits
The maximum number of available disk storage units associated with the servers in a package.protected List<Category>
categories
This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering.protected List<Configuration>
configuration
The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.protected Long
configurationCount
A count of the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.protected String
defaultBootCategoryCode
The default boot category code for the package.protected Long
defaultRamItemCount
A count of a collection of valid RAM items available for purchase in this package.protected List<Item>
defaultRamItems
A collection of valid RAM items available for purchase in this package.protected Long
deploymentCount
A count of the package that represents a multi-server solution.protected String
deploymentNodeType
The node type for a package in a solution deployment.protected Long
deploymentPackageCount
A count of the packages that are allowed in a multi-server solution.protected List<Package>
deploymentPackages
The packages that are allowed in a multi-server solution.protected List<Package>
deployments
The package that represents a multi-server solution.protected String
deploymentType
The solution deployment type.protected String
description
A generic description of the processor type and count.protected boolean
descriptionSpecified
protected Boolean
disallowCustomDiskPartitions
This flag indicates the package does not allow custom disk partitions.protected Step
firstOrderStep
The Softlayer order step is optionally step-based.protected Long
firstOrderStepId
This is only needed for step-based order verification.protected boolean
firstOrderStepIdSpecified
protected Boolean
gatewayApplianceFlag
Whether the package is a specialized network gateway appliance package.protected Boolean
gpuFlag
This flag indicates that the package supports GPUs.protected Boolean
hourlyBillingAvailableFlag
Determines whether the package contains prices that can be ordered hourly.protected Boolean
hourlyOnlyOrders
Packages with this flag do not allow monthly orders.protected Long
id
A package's internal identifier.protected boolean
idSpecified
protected Long
isActive
protected boolean
isActiveSpecified
protected List<Conflict>
itemConflicts
The item-item conflicts associated with a package.protected Long
itemCount
A count of a collection of valid items available for purchase in this package.protected List<Conflict>
itemLocationConflicts
The item-location conflicts associated with a package.protected Long
itemPriceCount
A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package.protected Long
itemPriceReferenceCount
A count of cross reference for item pricesprotected List<Prices>
itemPriceReferences
cross reference for item pricesprotected List<Price>
itemPrices
A collection of SoftLayer_Product_Item_Prices that are valid for this package.protected List<Item>
items
A collection of valid items available for purchase in this package.protected String
keyName
A unique key name for the package.protected boolean
keyNameSpecified
protected Long
locationCount
A count of a collection of valid locations for this package.protected List<Location>
locations
A collection of valid locations for this package.protected Price
lowestServerPrice
The lowest server [[SoftLayer_Product_Item_Price]] related to this package.protected Long
maximumPortSpeed
The maximum available network speed associated with the package.protected Long
minimumPortSpeed
The minimum available network speed associated with the package.protected Boolean
mongoDbEngineeredFlag
This flag indicates that this is a MongoDB engineered package.protected String
name
The description of the package.protected boolean
nameSpecified
protected Boolean
nonEuCompliantFlag
Whether the package is not in compliance with EU support.protected Boolean
noUpgradesFlag
Services ordered from this package cannot have upgrades or downgrades performed.protected Long
orderPremiumCount
A count of the premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.protected List<Premium>
orderPremiums
The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.protected Boolean
popLocationAvailabilityFlag
This flag indicates if the package may be available in PoP locations in addition to Datacenters.protected Boolean
preconfiguredFlag
This flag indicates the package is pre-configured.protected Boolean
presetConfigurationRequiredFlag
Whether the package requires the user to define a preset configuration.protected Boolean
preventVlanSelectionFlag
Whether the package prevents the user from specifying a Vlan.protected Boolean
privateHostedCloudPackageFlag
This flag indicates the package is for a private hosted cloud deployment.protected String
privateHostedCloudPackageType
The server role of the private hosted cloud deployment.protected Boolean
privateNetworkOnlyFlag
Whether the package only has access to the private network.protected Boolean
quantaStorPackageFlag
Whether the package is a specialized mass storage QuantaStor package.protected Boolean
raidDiskRestrictionFlag
This flag indicates the package does not allow different disks with RAID.protected Boolean
redundantPowerFlag
This flag determines if the package contains a redundant power supply product.protected Long
regionCount
A count of the regional locations that a package is available in.protected List<Region>
regions
The regional locations that a package is available in.protected Template
resourceGroupTemplate
The resource group template that describes a multi-server solution.protected String
subDescription
This currently contains no information but is here for future use.protected boolean
subDescriptionSpecified
protected String
topLevelItemCategoryCode
The top level category code for this service offering.protected Type
type
The type of service offering.protected Long
unitSize
The server unit size this package will match to.protected boolean
unitSizeSpecified
-
Constructor Summary
Constructors Constructor Description Package()
-
Method Summary
-
Field Details
-
accountRestrictedActivePresets
The preset configurations available only for the authenticated account and this package. -
accountRestrictedCategories
The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices. Not all accounts have restricted pricing. -
accountRestrictedPricesFlag
The flag to indicate if there are any restricted prices in a package for the currently-active account. -
activePresets
The available preset configurations for this package. -
activeRamItems
A collection of valid RAM items available for purchase in this package. -
activeServerItems
A collection of valid server items available for purchase in this package. -
activeSoftwareItems
A collection of valid software items available for purchase in this package. -
activeUsagePrices
A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage. -
additionalServiceFlag
This flag indicates that the package is an additional service. -
attributes
-
availableLocations
A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) -
availableStorageUnits
The maximum number of available disk storage units associated with the servers in a package. -
categories
This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([[SoftLayer_Product_Package_Item_Category_Group]]) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([[SoftLayer_Product_Item_Price]]) which you can use determine the cost of each product. Each price has a product ([[SoftLayer_Product_Item]]) which provides the name and other useful information about the server, service or software you may purchase. -
configuration
The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. -
defaultBootCategoryCode
The default boot category code for the package. -
defaultRamItems
A collection of valid RAM items available for purchase in this package. -
deploymentNodeType
The node type for a package in a solution deployment. -
deploymentPackages
The packages that are allowed in a multi-server solution. (Deprecated) -
deploymentType
The solution deployment type. -
deployments
The package that represents a multi-server solution. (Deprecated) -
disallowCustomDiskPartitions
This flag indicates the package does not allow custom disk partitions. -
firstOrderStep
The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process. -
gatewayApplianceFlag
Whether the package is a specialized network gateway appliance package. -
gpuFlag
This flag indicates that the package supports GPUs. -
hourlyBillingAvailableFlag
Determines whether the package contains prices that can be ordered hourly. -
hourlyOnlyOrders
Packages with this flag do not allow monthly orders. -
itemConflicts
The item-item conflicts associated with a package. -
itemLocationConflicts
The item-location conflicts associated with a package. -
itemPriceReferences
cross reference for item prices -
itemPrices
A collection of SoftLayer_Product_Item_Prices that are valid for this package. -
items
A collection of valid items available for purchase in this package. -
locations
A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) -
lowestServerPrice
The lowest server [[SoftLayer_Product_Item_Price]] related to this package. -
maximumPortSpeed
The maximum available network speed associated with the package. -
minimumPortSpeed
The minimum available network speed associated with the package. -
mongoDbEngineeredFlag
This flag indicates that this is a MongoDB engineered package. (Deprecated) -
noUpgradesFlag
Services ordered from this package cannot have upgrades or downgrades performed. -
nonEuCompliantFlag
Whether the package is not in compliance with EU support. -
orderPremiums
The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package. -
popLocationAvailabilityFlag
This flag indicates if the package may be available in PoP locations in addition to Datacenters. -
preconfiguredFlag
This flag indicates the package is pre-configured. (Deprecated) -
presetConfigurationRequiredFlag
Whether the package requires the user to define a preset configuration. -
preventVlanSelectionFlag
Whether the package prevents the user from specifying a Vlan. -
privateHostedCloudPackageFlag
This flag indicates the package is for a private hosted cloud deployment. (Deprecated) -
privateHostedCloudPackageType
The server role of the private hosted cloud deployment. (Deprecated) -
privateNetworkOnlyFlag
Whether the package only has access to the private network. -
quantaStorPackageFlag
Whether the package is a specialized mass storage QuantaStor package. (Deprecated) -
raidDiskRestrictionFlag
This flag indicates the package does not allow different disks with RAID. -
redundantPowerFlag
This flag determines if the package contains a redundant power supply product. -
regions
The regional locations that a package is available in. -
resourceGroupTemplate
The resource group template that describes a multi-server solution. (Deprecated) -
topLevelItemCategoryCode
The top level category code for this service offering. -
type
The type of service offering. This property can be used to help filter packages. -
description
A generic description of the processor type and count. This includes HTML, so you may want to strip these tags if you plan to use it. -
descriptionSpecified
protected boolean descriptionSpecified -
firstOrderStepId
This is only needed for step-based order verification. We use this for the order forms, but it is not required. This step is the first SoftLayer_Product_Package_Step for this package. Use this for for filtering which item categories are returned as a part of SoftLayer_Product_Package_Order_Configuration. -
firstOrderStepIdSpecified
protected boolean firstOrderStepIdSpecified -
id
A package's internal identifier. Everything regarding a SoftLayer_Product_Package is tied back to this id. -
idSpecified
protected boolean idSpecified -
isActive
-
isActiveSpecified
protected boolean isActiveSpecified -
keyName
A unique key name for the package. -
keyNameSpecified
protected boolean keyNameSpecified -
name
The description of the package. For server packages, this is usually a detailed description of processor type and count. -
nameSpecified
protected boolean nameSpecified -
subDescription
This currently contains no information but is here for future use. -
subDescriptionSpecified
protected boolean subDescriptionSpecified -
unitSize
The server unit size this package will match to. -
unitSizeSpecified
protected boolean unitSizeSpecified -
accountRestrictedActivePresetCount
A count of the preset configurations available only for the authenticated account and this package. -
accountRestrictedCategoryCount
A count of the results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices. Not all accounts have restricted pricing. -
activePresetCount
A count of the available preset configurations for this package. -
activeRamItemCount
A count of a collection of valid RAM items available for purchase in this package. -
activeServerItemCount
A count of a collection of valid server items available for purchase in this package. -
activeSoftwareItemCount
A count of a collection of valid software items available for purchase in this package. -
activeUsagePriceCount
A count of a collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage. -
attributeCount
A count of -
availableLocationCount
A count of a collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) -
configurationCount
A count of the item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. -
defaultRamItemCount
A count of a collection of valid RAM items available for purchase in this package. -
deploymentCount
A count of the package that represents a multi-server solution. (Deprecated) -
deploymentPackageCount
A count of the packages that are allowed in a multi-server solution. (Deprecated) -
itemCount
A count of a collection of valid items available for purchase in this package. -
itemPriceCount
A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package. -
itemPriceReferenceCount
A count of cross reference for item prices -
locationCount
A count of a collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) -
orderPremiumCount
A count of the premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package. -
regionCount
A count of the regional locations that a package is available in.
-
-
Constructor Details
-
Package
public Package()
-
-
Method Details
-
getAccountRestrictedActivePresets
-
getAccountRestrictedCategories
-
getAccountRestrictedPricesFlag
-
setAccountRestrictedPricesFlag
-
getActivePresets
-
getActiveRamItems
-
getActiveServerItems
-
getActiveSoftwareItems
-
getActiveUsagePrices
-
getAdditionalServiceFlag
-
setAdditionalServiceFlag
-
getAttributes
-
getAvailableLocations
-
getAvailableStorageUnits
-
setAvailableStorageUnits
-
getCategories
-
getConfiguration
-
getDefaultBootCategoryCode
-
setDefaultBootCategoryCode
-
getDefaultRamItems
-
getDeploymentNodeType
-
setDeploymentNodeType
-
getDeploymentPackages
-
getDeploymentType
-
setDeploymentType
-
getDeployments
-
getDisallowCustomDiskPartitions
-
setDisallowCustomDiskPartitions
-
getFirstOrderStep
-
setFirstOrderStep
-
getGatewayApplianceFlag
-
setGatewayApplianceFlag
-
getGpuFlag
-
setGpuFlag
-
getHourlyBillingAvailableFlag
-
setHourlyBillingAvailableFlag
-
getHourlyOnlyOrders
-
setHourlyOnlyOrders
-
getItemConflicts
-
getItemLocationConflicts
-
getItemPriceReferences
-
getItemPrices
-
getItems
-
getLocations
-
getLowestServerPrice
-
setLowestServerPrice
-
getMaximumPortSpeed
-
setMaximumPortSpeed
-
getMinimumPortSpeed
-
setMinimumPortSpeed
-
getMongoDbEngineeredFlag
-
setMongoDbEngineeredFlag
-
getNoUpgradesFlag
-
setNoUpgradesFlag
-
getNonEuCompliantFlag
-
setNonEuCompliantFlag
-
getOrderPremiums
-
getPopLocationAvailabilityFlag
-
setPopLocationAvailabilityFlag
-
getPreconfiguredFlag
-
setPreconfiguredFlag
-
getPresetConfigurationRequiredFlag
-
setPresetConfigurationRequiredFlag
-
getPreventVlanSelectionFlag
-
setPreventVlanSelectionFlag
-
getPrivateHostedCloudPackageFlag
-
setPrivateHostedCloudPackageFlag
-
getPrivateHostedCloudPackageType
-
setPrivateHostedCloudPackageType
-
getPrivateNetworkOnlyFlag
-
setPrivateNetworkOnlyFlag
-
getQuantaStorPackageFlag
-
setQuantaStorPackageFlag
-
getRaidDiskRestrictionFlag
-
setRaidDiskRestrictionFlag
-
getRedundantPowerFlag
-
setRedundantPowerFlag
-
getRegions
-
getResourceGroupTemplate
-
setResourceGroupTemplate
-
getTopLevelItemCategoryCode
-
setTopLevelItemCategoryCode
-
getType
-
setType
-
getDescription
-
setDescription
-
isDescriptionSpecified
public boolean isDescriptionSpecified() -
unsetDescription
public void unsetDescription() -
getFirstOrderStepId
-
setFirstOrderStepId
-
isFirstOrderStepIdSpecified
public boolean isFirstOrderStepIdSpecified() -
unsetFirstOrderStepId
public void unsetFirstOrderStepId() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getIsActive
-
setIsActive
-
isIsActiveSpecified
public boolean isIsActiveSpecified() -
unsetIsActive
public void unsetIsActive() -
getKeyName
-
setKeyName
-
isKeyNameSpecified
public boolean isKeyNameSpecified() -
unsetKeyName
public void unsetKeyName() -
getName
-
setName
-
isNameSpecified
public boolean isNameSpecified() -
unsetName
public void unsetName() -
getSubDescription
-
setSubDescription
-
isSubDescriptionSpecified
public boolean isSubDescriptionSpecified() -
unsetSubDescription
public void unsetSubDescription() -
getUnitSize
-
setUnitSize
-
isUnitSizeSpecified
public boolean isUnitSizeSpecified() -
unsetUnitSize
public void unsetUnitSize() -
getAccountRestrictedActivePresetCount
-
setAccountRestrictedActivePresetCount
-
getAccountRestrictedCategoryCount
-
setAccountRestrictedCategoryCount
-
getActivePresetCount
-
setActivePresetCount
-
getActiveRamItemCount
-
setActiveRamItemCount
-
getActiveServerItemCount
-
setActiveServerItemCount
-
getActiveSoftwareItemCount
-
setActiveSoftwareItemCount
-
getActiveUsagePriceCount
-
setActiveUsagePriceCount
-
getAttributeCount
-
setAttributeCount
-
getAvailableLocationCount
-
setAvailableLocationCount
-
getConfigurationCount
-
setConfigurationCount
-
getDefaultRamItemCount
-
setDefaultRamItemCount
-
getDeploymentCount
-
setDeploymentCount
-
getDeploymentPackageCount
-
setDeploymentPackageCount
-
getItemCount
-
setItemCount
-
getItemPriceCount
-
setItemPriceCount
-
getItemPriceReferenceCount
-
setItemPriceReferenceCount
-
getLocationCount
-
setLocationCount
-
getOrderPremiumCount
-
setOrderPremiumCount
-
getRegionCount
-
setRegionCount
-
asService
-
service
-
service
-