Class Preset
- java.lang.Object
-
- com.softlayer.api.Type
-
- com.softlayer.api.service.Entity
-
- com.softlayer.api.service.product.pkg.Preset
-
@ApiType("SoftLayer_Product_Package_Preset") public class Preset extends Entity
Package presets are used to simplify ordering by eliminating the need for price ids when submitting orders.
Orders submitted with a preset id defined will use the prices included in the package preset. Prices submitted on an order with a preset id will replace the prices included in the package preset for that prices category. If the package preset has a fixed configuration flag (fixedConfigurationFlag) set then the prices included in the preset configuration cannot be replaced by prices submitted on the order. The only exception to the fixed configuration flag would be if a price submitted on the order is an account-restricted price for the same product item.- See Also:
- SoftLayer_Product_Package_Preset
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Preset.Mask
static interface
Preset.Service
static interface
Preset.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Long
availableStorageUnits
protected Boolean
bareMetalReservedFlag
When true this preset is for ordering a Bare Metal Reserved server.protected List<Category>
categories
The item categories that are included in this package preset configuration.protected Long
categoryCount
A count of the item categories that are included in this package preset configuration.protected Group
computeGroup
The compute family this configuration belongs to.protected List<Configuration>
configuration
The preset configuration (category and price).protected Long
configurationCount
A count of the preset configuration (category and price).protected String
description
A description of the package preset.protected boolean
descriptionSpecified
protected Boolean
disallowedComputeGroupUpgradeFlag
When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.protected Boolean
fixedConfigurationFlag
A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement.protected Long
id
A preset's internal identifier.protected boolean
idSpecified
protected String
isActive
The status of the package preset.protected boolean
isActiveSpecified
protected String
keyName
The key name of the package preset.protected boolean
keyNameSpecified
protected Long
locationCount
A count of the locations this preset configuration is available in.protected List<Location>
locations
The locations this preset configuration is available in.protected Price
lowestPresetServerPrice
The lowest server prices related to this package preset.protected String
name
The name of the package preset.protected boolean
nameSpecified
protected List<Configuration>
packageConfiguration
The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.protected Long
packageConfigurationCount
A count of the item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.protected Long
packageId
The package id for the package this preset belongs to.protected boolean
packageIdSpecified
protected Package
presetPackage
The package this preset belongs to.protected Long
priceCount
A count of the item prices that are included in this package preset configuration.protected List<Price>
prices
The item prices that are included in this package preset configuration.protected Long
storageGroupTemplateArrayCount
A count of describes how all disks in this preset will be configured.protected List<Group>
storageGroupTemplateArrays
Describes how all disks in this preset will be configured.protected BigDecimal
totalMinimumHourlyFee
The starting hourly price for this configuration.protected BigDecimal
totalMinimumRecurringFee
The starting monthly price for this configuration.-
Fields inherited from class com.softlayer.api.Type
unknownProperties
-
-
Constructor Summary
Constructors Constructor Description Preset()
-
Method Summary
-
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
-
-
-
Field Detail
-
availableStorageUnits
@ApiProperty protected Long availableStorageUnits
-
bareMetalReservedFlag
@ApiProperty protected Boolean bareMetalReservedFlag
When true this preset is for ordering a Bare Metal Reserved server.
-
categories
@ApiProperty protected List<Category> categories
The item categories that are included in this package preset configuration.
-
computeGroup
@ApiProperty protected Group computeGroup
The compute family this configuration belongs to.
-
configuration
@ApiProperty protected List<Configuration> configuration
The preset configuration (category and price).
-
disallowedComputeGroupUpgradeFlag
@ApiProperty protected Boolean disallowedComputeGroupUpgradeFlag
When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.
-
fixedConfigurationFlag
@ApiProperty protected Boolean fixedConfigurationFlag
A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement.
-
locations
@ApiProperty protected List<Location> locations
The locations this preset configuration is available in. If empty the preset is available in all locations the package is available in.
-
lowestPresetServerPrice
@ApiProperty protected Price lowestPresetServerPrice
The lowest server prices related to this package preset.
-
presetPackage
@ApiProperty("package") protected Package presetPackage
The package this preset belongs to.
-
packageConfiguration
@ApiProperty protected List<Configuration> packageConfiguration
The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.
-
prices
@ApiProperty protected List<Price> prices
The item prices that are included in this package preset configuration.
-
storageGroupTemplateArrays
@ApiProperty protected List<Group> storageGroupTemplateArrays
Describes how all disks in this preset will be configured.
-
totalMinimumHourlyFee
@ApiProperty protected BigDecimal totalMinimumHourlyFee
The starting hourly price for this configuration. Additional options not defined in the preset may increase the cost.
-
totalMinimumRecurringFee
@ApiProperty protected BigDecimal totalMinimumRecurringFee
The starting monthly price for this configuration. Additional options not defined in the preset may increase the cost.
-
description
@ApiProperty(canBeNullOrNotSet=true) protected String description
A description of the package preset.
-
descriptionSpecified
protected boolean descriptionSpecified
-
id
@ApiProperty(canBeNullOrNotSet=true) protected Long id
A preset's internal identifier. Everything regarding a SoftLayer_Product_Package_Preset is tied back to this id.
-
idSpecified
protected boolean idSpecified
-
isActive
@ApiProperty(canBeNullOrNotSet=true) protected String isActive
The status of the package preset.
-
isActiveSpecified
protected boolean isActiveSpecified
-
keyName
@ApiProperty(canBeNullOrNotSet=true) protected String keyName
The key name of the package preset. For the base configuration of a package the preset key name is "DEFAULT".
-
keyNameSpecified
protected boolean keyNameSpecified
-
name
@ApiProperty(canBeNullOrNotSet=true) protected String name
The name of the package preset.
-
nameSpecified
protected boolean nameSpecified
-
packageId
@ApiProperty(canBeNullOrNotSet=true) protected Long packageId
The package id for the package this preset belongs to.
-
packageIdSpecified
protected boolean packageIdSpecified
-
categoryCount
@ApiProperty protected Long categoryCount
A count of the item categories that are included in this package preset configuration.
-
configurationCount
@ApiProperty protected Long configurationCount
A count of the preset configuration (category and price).
-
locationCount
@ApiProperty protected Long locationCount
A count of the locations this preset configuration is available in. If empty the preset is available in all locations the package is available in.
-
packageConfigurationCount
@ApiProperty protected Long packageConfigurationCount
A count of the item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.
-
priceCount
@ApiProperty protected Long priceCount
A count of the item prices that are included in this package preset configuration.
-
storageGroupTemplateArrayCount
@ApiProperty protected Long storageGroupTemplateArrayCount
A count of describes how all disks in this preset will be configured.
-
-
Method Detail
-
getAvailableStorageUnits
public Long getAvailableStorageUnits()
-
setAvailableStorageUnits
public void setAvailableStorageUnits(Long availableStorageUnits)
-
getBareMetalReservedFlag
public Boolean getBareMetalReservedFlag()
-
setBareMetalReservedFlag
public void setBareMetalReservedFlag(Boolean bareMetalReservedFlag)
-
getComputeGroup
public Group getComputeGroup()
-
setComputeGroup
public void setComputeGroup(Group computeGroup)
-
getConfiguration
public List<Configuration> getConfiguration()
-
getDisallowedComputeGroupUpgradeFlag
public Boolean getDisallowedComputeGroupUpgradeFlag()
-
setDisallowedComputeGroupUpgradeFlag
public void setDisallowedComputeGroupUpgradeFlag(Boolean disallowedComputeGroupUpgradeFlag)
-
getFixedConfigurationFlag
public Boolean getFixedConfigurationFlag()
-
setFixedConfigurationFlag
public void setFixedConfigurationFlag(Boolean fixedConfigurationFlag)
-
getLowestPresetServerPrice
public Price getLowestPresetServerPrice()
-
setLowestPresetServerPrice
public void setLowestPresetServerPrice(Price lowestPresetServerPrice)
-
getPresetPackage
public Package getPresetPackage()
-
setPresetPackage
public void setPresetPackage(Package presetPackage)
-
getPackageConfiguration
public List<Configuration> getPackageConfiguration()
-
getTotalMinimumHourlyFee
public BigDecimal getTotalMinimumHourlyFee()
-
setTotalMinimumHourlyFee
public void setTotalMinimumHourlyFee(BigDecimal totalMinimumHourlyFee)
-
getTotalMinimumRecurringFee
public BigDecimal getTotalMinimumRecurringFee()
-
setTotalMinimumRecurringFee
public void setTotalMinimumRecurringFee(BigDecimal totalMinimumRecurringFee)
-
getDescription
public String getDescription()
-
setDescription
public void setDescription(String description)
-
isDescriptionSpecified
public boolean isDescriptionSpecified()
-
unsetDescription
public void unsetDescription()
-
getId
public Long getId()
-
setId
public void setId(Long id)
-
isIdSpecified
public boolean isIdSpecified()
-
unsetId
public void unsetId()
-
getIsActive
public String getIsActive()
-
setIsActive
public void setIsActive(String isActive)
-
isIsActiveSpecified
public boolean isIsActiveSpecified()
-
unsetIsActive
public void unsetIsActive()
-
getKeyName
public String getKeyName()
-
setKeyName
public void setKeyName(String keyName)
-
isKeyNameSpecified
public boolean isKeyNameSpecified()
-
unsetKeyName
public void unsetKeyName()
-
getName
public String getName()
-
setName
public void setName(String name)
-
isNameSpecified
public boolean isNameSpecified()
-
unsetName
public void unsetName()
-
getPackageId
public Long getPackageId()
-
setPackageId
public void setPackageId(Long packageId)
-
isPackageIdSpecified
public boolean isPackageIdSpecified()
-
unsetPackageId
public void unsetPackageId()
-
getCategoryCount
public Long getCategoryCount()
-
setCategoryCount
public void setCategoryCount(Long categoryCount)
-
getConfigurationCount
public Long getConfigurationCount()
-
setConfigurationCount
public void setConfigurationCount(Long configurationCount)
-
getLocationCount
public Long getLocationCount()
-
setLocationCount
public void setLocationCount(Long locationCount)
-
getPackageConfigurationCount
public Long getPackageConfigurationCount()
-
setPackageConfigurationCount
public void setPackageConfigurationCount(Long packageConfigurationCount)
-
getPriceCount
public Long getPriceCount()
-
setPriceCount
public void setPriceCount(Long priceCount)
-
getStorageGroupTemplateArrayCount
public Long getStorageGroupTemplateArrayCount()
-
setStorageGroupTemplateArrayCount
public void setStorageGroupTemplateArrayCount(Long storageGroupTemplateArrayCount)
-
asService
public Preset.Service asService(ApiClient client)
-
service
public static Preset.Service service(ApiClient client)
-
service
public static Preset.Service service(ApiClient client, Long id)
-
-