Interface Package.Service
-
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Package
@ApiService("SoftLayer_Product_Package") public static interface Package.Service extends Service
Every SoftLayer_Product_Package contains information related products and services that SoftLayer sells. The configuration of this package reveals which categories are required to place an order for this package. Every package has items, item prices, locations, regions, and a configuration. This service is the starting point for ordering servers, and other services we provide.- See Also:
- SoftLayer_Product_Package
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Package.ServiceAsync
asAsync()
Get an async version of this serviceList<Preset>
getAccountRestrictedActivePresets()
The preset configurations available only for the authenticated account and this package.List<Category>
getAccountRestrictedCategories()
The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices.Boolean
getAccountRestrictedPricesFlag()
The flag to indicate if there are any restricted prices in a package for the currently-active account.List<Item>
getActiveItems()
Return a list of Items in the package with their active prices.List<Package>
getActivePackagesByAttribute(String attributeKeyName)
Deprecated.List<Preset>
getActivePresets()
The available preset configurations for this package.List<Package>
getActivePrivateHostedCloudPackages()
Deprecated.List<Item>
getActiveRamItems()
A collection of valid RAM items available for purchase in this package.List<Item>
getActiveServerItems()
A collection of valid server items available for purchase in this package.List<Item>
getActiveSoftwareItems()
A collection of valid software items available for purchase in this package.List<Price>
getActiveUsagePrices()
A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.List<Price>
getActiveUsageRatePrices(Long locationId, String categoryCode)
This method returns a collection of active usage rate [[SoftLayer_Product_Item_Price]] objects for the current package and specified datacenter.Boolean
getAdditionalServiceFlag()
This flag indicates that the package is an additional service.List<Package>
getAllObjects()
This method pulls all the active packages.List<Attribute>
getAttributes()
List<Locations>
getAvailableLocations()
A collection of valid locations for this package.List<Package>
getAvailablePackagesForImageTemplate(Group imageTemplate)
Long
getAvailableStorageUnits()
The maximum number of available disk storage units associated with the servers in a package.List<Category>
getCategories()
This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering.List<Item>
getCdnItems()
List<Item>
getCloudStorageItems(Long provider)
List<Configuration>
getConfiguration()
The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.String
getDefaultBootCategoryCode()
The default boot category code for the package.List<Item>
getDefaultRamItems()
A collection of valid RAM items available for purchase in this package.String
getDeploymentNodeType()
The node type for a package in a solution deployment.List<Package>
getDeploymentPackages()
The packages that are allowed in a multi-server solution.List<Package>
getDeployments()
The package that represents a multi-server solution.String
getDeploymentType()
The solution deployment type.Boolean
getDisallowCustomDiskPartitions()
This flag indicates the package does not allow custom disk partitions.Step
getFirstOrderStep()
The Softlayer order step is optionally step-based.Boolean
getGatewayApplianceFlag()
Whether the package is a specialized network gateway appliance package.Boolean
getGpuFlag()
This flag indicates that the package supports GPUs.Boolean
getHourlyBillingAvailableFlag()
Determines whether the package contains prices that can be ordered hourly.Boolean
getHourlyOnlyOrders()
Packages with this flag do not allow monthly orders.List<Type>
getItemAvailabilityTypes()
Returns a collection of SoftLayer_Product_Item_Attribute_Type objects.List<Conflict>
getItemConflicts()
The item-item conflicts associated with a package.List<Conflict>
getItemLocationConflicts()
The item-location conflicts associated with a package.List<Prices>
getItemPriceReferences()
cross reference for item pricesList<Price>
getItemPrices()
A collection of SoftLayer_Product_Item_Prices that are valid for this package.List<Price>
getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_DescriptionList<Item>
getItems()
A collection of valid items available for purchase in this package.List<Item>
getItemsFromImageTemplate(Group imageTemplate)
Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objectList<Location>
getLocations()
A collection of valid locations for this package.Price
getLowestServerPrice()
The lowest server [[SoftLayer_Product_Item_Price]] related to this package.Long
getMaximumPortSpeed()
The maximum available network speed associated with the package.List<Item>
getMessageQueueItems()
Long
getMinimumPortSpeed()
The minimum available network speed associated with the package.Boolean
getMongoDbEngineeredFlag()
This flag indicates that this is a MongoDB engineered package.Boolean
getNonEuCompliantFlag()
Whether the package is not in compliance with EU support.Boolean
getNoUpgradesFlag()
Services ordered from this package cannot have upgrades or downgrades performed.Package
getObject()
List<Datacenter>
getObjectStorageDatacenters()
This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter]] objects which contain a datacenter location and all the associated active usage rate prices where object storage is available.List<LocationGroup>
getObjectStorageLocationGroups()
This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup]] objects which contain a location group and all the associated active usage rate prices where object storage is available.List<Premium>
getOrderPremiums()
The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.Boolean
getPopLocationAvailabilityFlag()
This flag indicates if the package may be available in PoP locations in addition to Datacenters.Boolean
getPreconfiguredFlag()
This flag indicates the package is pre-configured.Boolean
getPresetConfigurationRequiredFlag()
Whether the package requires the user to define a preset configuration.Boolean
getPreventVlanSelectionFlag()
Whether the package prevents the user from specifying a Vlan.Boolean
getPrivateHostedCloudPackageFlag()
This flag indicates the package is for a private hosted cloud deployment.String
getPrivateHostedCloudPackageType()
The server role of the private hosted cloud deployment.Boolean
getPrivateNetworkOnlyFlag()
Whether the package only has access to the private network.Boolean
getQuantaStorPackageFlag()
Whether the package is a specialized mass storage QuantaStor package.Boolean
getRaidDiskRestrictionFlag()
This flag indicates the package does not allow different disks with RAID.Boolean
getRedundantPowerFlag()
This flag determines if the package contains a redundant power supply product.List<Region>
getRegions()
The regional locations that a package is available in.Template
getResourceGroupTemplate()
The resource group template that describes a multi-server solution.List<Category>
getStandardCategories()
This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing.String
getTopLevelItemCategoryCode()
The top level category code for this service offering.Type
getType()
The type of service offering.void
setMask(Package.Mask mask)
Package.Mask
withMask()
Use the existing mask on this service or create it if not presentPackage.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return it-
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
-
-
-
Method Detail
-
asAsync
Package.ServiceAsync asAsync()
Description copied from interface:Service
Get an async version of this service
-
withNewMask
Package.Mask withNewMask()
Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Package.Mask withMask()
Description copied from interface:Maskable
Use the existing mask on this service or create it if not present
-
setMask
void setMask(Package.Mask mask)
-
getActiveItems
@ApiMethod(instanceRequired=true) List<Item> getActiveItems()
Return a list of Items in the package with their active prices.
-
getActivePackagesByAttribute
@Deprecated @ApiMethod List<Package> getActivePackagesByAttribute(String attributeKeyName)
Deprecated.This method is deprecated and should not be used in production code.
This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information.
-
getActivePrivateHostedCloudPackages
@Deprecated @ApiMethod List<Package> getActivePrivateHostedCloudPackages()
Deprecated.[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations.
-
getActiveUsageRatePrices
@ApiMethod(instanceRequired=true) List<Price> getActiveUsageRatePrices(Long locationId, String categoryCode)
This method returns a collection of active usage rate [[SoftLayer_Product_Item_Price]] objects for the current package and specified datacenter. Optionally you can retrieve the active usage rate prices for a particular [[SoftLayer_Product_Item_Category]] by specifying a category code as the first parameter. This information is useful so that you can see "pay as you go" rates (if any) for the current package, location and optionally category.
-
getAllObjects
@ApiMethod List<Package> getAllObjects()
This method pulls all the active packages. This will give you a basic description of the packages that are currently active- See Also:
- SoftLayer_Product_Package::getAllObjects
-
getAvailablePackagesForImageTemplate
@ApiMethod List<Package> getAvailablePackagesForImageTemplate(Group imageTemplate)
-
getCdnItems
@ApiMethod(instanceRequired=true) List<Item> getCdnItems()
- See Also:
- SoftLayer_Product_Package::getCdnItems
-
getCloudStorageItems
@ApiMethod(instanceRequired=true) List<Item> getCloudStorageItems(Long provider)
-
getItemAvailabilityTypes
@ApiMethod List<Type> getItemAvailabilityTypes()
Returns a collection of SoftLayer_Product_Item_Attribute_Type objects. These item attribute types specifically deal with when an item, SoftLayer_Product_Item, from the product catalog may no longer be available. The keynames for these attribute types start with 'UNAVAILABLE_AFTER_DATE_*', where the '*' may represent any string. For example, 'UNAVAILABLE_AFTER_DATE_NEW_ORDERS', signifies that the item is not available for new orders. There is a catch all attribute type, 'UNAVAILABLE_AFTER_DATE_ALL'. If an item has one of these availability attributes set, the value should be a valid date in MM/DD/YYYY, indicating the date after which the item will no longer be available.
-
getItemPricesFromSoftwareDescriptions
@ApiMethod(instanceRequired=true) List<Price> getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)
Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
-
getItemsFromImageTemplate
@ApiMethod(instanceRequired=true) List<Item> getItemsFromImageTemplate(Group imageTemplate)
Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] object
-
getMessageQueueItems
@ApiMethod(instanceRequired=true) List<Item> getMessageQueueItems()
-
getObject
@ApiMethod(instanceRequired=true) Package getObject()
- See Also:
- SoftLayer_Product_Package::getObject
-
getObjectStorageDatacenters
@ApiMethod(instanceRequired=true) List<Datacenter> getObjectStorageDatacenters()
This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter]] objects which contain a datacenter location and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of '''ADDITIONAL_SERVICES_OBJECT_STORAGE'''. This information is useful so that you can see the "pay as you go" rates per datacenter.
-
getObjectStorageLocationGroups
@ApiMethod(instanceRequired=true) List<LocationGroup> getObjectStorageLocationGroups()
This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup]] objects which contain a location group and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of '''ADDITIONAL_SERVICES_OBJECT_STORAGE'''. This information is useful so that you can see the "pay as you go" rates per location group.
-
getStandardCategories
@ApiMethod(instanceRequired=true) List<Category> getStandardCategories()
This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing. Not all accounts have restricted pricing.
-
getAccountRestrictedActivePresets
@ApiMethod(instanceRequired=true) List<Preset> getAccountRestrictedActivePresets()
The preset configurations available only for the authenticated account and this package.
-
getAccountRestrictedCategories
@ApiMethod(instanceRequired=true) List<Category> getAccountRestrictedCategories()
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.
-
getAccountRestrictedPricesFlag
@ApiMethod(instanceRequired=true) Boolean getAccountRestrictedPricesFlag()
The flag to indicate if there are any restricted prices in a package for the currently-active account.
-
getActivePresets
@ApiMethod(instanceRequired=true) List<Preset> getActivePresets()
The available preset configurations for this package.
-
getActiveRamItems
@ApiMethod(instanceRequired=true) List<Item> getActiveRamItems()
A collection of valid RAM items available for purchase in this package.
-
getActiveServerItems
@ApiMethod(instanceRequired=true) List<Item> getActiveServerItems()
A collection of valid server items available for purchase in this package.
-
getActiveSoftwareItems
@ApiMethod(instanceRequired=true) List<Item> getActiveSoftwareItems()
A collection of valid software items available for purchase in this package.
-
getActiveUsagePrices
@ApiMethod(instanceRequired=true) List<Price> getActiveUsagePrices()
A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.
-
getAdditionalServiceFlag
@ApiMethod(instanceRequired=true) Boolean getAdditionalServiceFlag()
This flag indicates that the package is an additional service.
-
getAttributes
@ApiMethod(instanceRequired=true) List<Attribute> getAttributes()
- See Also:
- SoftLayer_Product_Package::getAttributes
-
getAvailableLocations
@ApiMethod(instanceRequired=true) List<Locations> getAvailableLocations()
A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])
-
getAvailableStorageUnits
@ApiMethod(instanceRequired=true) Long getAvailableStorageUnits()
The maximum number of available disk storage units associated with the servers in a package.
-
getCategories
@ApiMethod(instanceRequired=true) List<Category> getCategories()
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.- See Also:
- SoftLayer_Product_Package::getCategories
-
getConfiguration
@ApiMethod(instanceRequired=true) List<Configuration> getConfiguration()
The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.
-
getDefaultBootCategoryCode
@ApiMethod(instanceRequired=true) String getDefaultBootCategoryCode()
The default boot category code for the package.
-
getDefaultRamItems
@ApiMethod(instanceRequired=true) List<Item> getDefaultRamItems()
A collection of valid RAM items available for purchase in this package.
-
getDeploymentNodeType
@ApiMethod(instanceRequired=true) String getDeploymentNodeType()
The node type for a package in a solution deployment.
-
getDeploymentPackages
@ApiMethod(instanceRequired=true) List<Package> getDeploymentPackages()
The packages that are allowed in a multi-server solution. (Deprecated)
-
getDeploymentType
@ApiMethod(instanceRequired=true) String getDeploymentType()
The solution deployment type.
-
getDeployments
@ApiMethod(instanceRequired=true) List<Package> getDeployments()
The package that represents a multi-server solution. (Deprecated)
-
getDisallowCustomDiskPartitions
@ApiMethod(instanceRequired=true) Boolean getDisallowCustomDiskPartitions()
This flag indicates the package does not allow custom disk partitions.
-
getFirstOrderStep
@ApiMethod(instanceRequired=true) Step getFirstOrderStep()
The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process.
-
getGatewayApplianceFlag
@ApiMethod(instanceRequired=true) Boolean getGatewayApplianceFlag()
Whether the package is a specialized network gateway appliance package.
-
getGpuFlag
@ApiMethod(instanceRequired=true) Boolean getGpuFlag()
This flag indicates that the package supports GPUs.- See Also:
- SoftLayer_Product_Package::getGpuFlag
-
getHourlyBillingAvailableFlag
@ApiMethod(instanceRequired=true) Boolean getHourlyBillingAvailableFlag()
Determines whether the package contains prices that can be ordered hourly.
-
getHourlyOnlyOrders
@ApiMethod(instanceRequired=true) Boolean getHourlyOnlyOrders()
Packages with this flag do not allow monthly orders.
-
getItemConflicts
@ApiMethod(instanceRequired=true) List<Conflict> getItemConflicts()
The item-item conflicts associated with a package.
-
getItemLocationConflicts
@ApiMethod(instanceRequired=true) List<Conflict> getItemLocationConflicts()
The item-location conflicts associated with a package.
-
getItemPriceReferences
@ApiMethod(instanceRequired=true) List<Prices> getItemPriceReferences()
cross reference for item prices
-
getItemPrices
@ApiMethod(instanceRequired=true) List<Price> getItemPrices()
A collection of SoftLayer_Product_Item_Prices that are valid for this package.- See Also:
- SoftLayer_Product_Package::getItemPrices
-
getItems
@ApiMethod(instanceRequired=true) List<Item> getItems()
A collection of valid items available for purchase in this package.- See Also:
- SoftLayer_Product_Package::getItems
-
getLocations
@ApiMethod(instanceRequired=true) List<Location> getLocations()
A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])- See Also:
- SoftLayer_Product_Package::getLocations
-
getLowestServerPrice
@ApiMethod(instanceRequired=true) Price getLowestServerPrice()
The lowest server [[SoftLayer_Product_Item_Price]] related to this package.
-
getMaximumPortSpeed
@ApiMethod(instanceRequired=true) Long getMaximumPortSpeed()
The maximum available network speed associated with the package.
-
getMinimumPortSpeed
@ApiMethod(instanceRequired=true) Long getMinimumPortSpeed()
The minimum available network speed associated with the package.
-
getMongoDbEngineeredFlag
@ApiMethod(instanceRequired=true) Boolean getMongoDbEngineeredFlag()
This flag indicates that this is a MongoDB engineered package. (Deprecated)
-
getNoUpgradesFlag
@ApiMethod(instanceRequired=true) Boolean getNoUpgradesFlag()
Services ordered from this package cannot have upgrades or downgrades performed.
-
getNonEuCompliantFlag
@ApiMethod(instanceRequired=true) Boolean getNonEuCompliantFlag()
Whether the package is not in compliance with EU support.
-
getOrderPremiums
@ApiMethod(instanceRequired=true) List<Premium> getOrderPremiums()
The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.
-
getPopLocationAvailabilityFlag
@ApiMethod(instanceRequired=true) Boolean getPopLocationAvailabilityFlag()
This flag indicates if the package may be available in PoP locations in addition to Datacenters.
-
getPreconfiguredFlag
@ApiMethod(instanceRequired=true) Boolean getPreconfiguredFlag()
This flag indicates the package is pre-configured. (Deprecated)
-
getPresetConfigurationRequiredFlag
@ApiMethod(instanceRequired=true) Boolean getPresetConfigurationRequiredFlag()
Whether the package requires the user to define a preset configuration.
-
getPreventVlanSelectionFlag
@ApiMethod(instanceRequired=true) Boolean getPreventVlanSelectionFlag()
Whether the package prevents the user from specifying a Vlan.
-
getPrivateHostedCloudPackageFlag
@ApiMethod(instanceRequired=true) Boolean getPrivateHostedCloudPackageFlag()
This flag indicates the package is for a private hosted cloud deployment. (Deprecated)
-
getPrivateHostedCloudPackageType
@ApiMethod(instanceRequired=true) String getPrivateHostedCloudPackageType()
The server role of the private hosted cloud deployment. (Deprecated)
-
getPrivateNetworkOnlyFlag
@ApiMethod(instanceRequired=true) Boolean getPrivateNetworkOnlyFlag()
Whether the package only has access to the private network.
-
getQuantaStorPackageFlag
@ApiMethod(instanceRequired=true) Boolean getQuantaStorPackageFlag()
Whether the package is a specialized mass storage QuantaStor package. (Deprecated)
-
getRaidDiskRestrictionFlag
@ApiMethod(instanceRequired=true) Boolean getRaidDiskRestrictionFlag()
This flag indicates the package does not allow different disks with RAID.
-
getRedundantPowerFlag
@ApiMethod(instanceRequired=true) Boolean getRedundantPowerFlag()
This flag determines if the package contains a redundant power supply product.
-
getRegions
@ApiMethod(instanceRequired=true) List<Region> getRegions()
The regional locations that a package is available in.- See Also:
- SoftLayer_Product_Package::getRegions
-
getResourceGroupTemplate
@ApiMethod(instanceRequired=true) Template getResourceGroupTemplate()
The resource group template that describes a multi-server solution. (Deprecated)
-
getTopLevelItemCategoryCode
@ApiMethod(instanceRequired=true) String getTopLevelItemCategoryCode()
The top level category code for this service offering.
-
getType
@ApiMethod(instanceRequired=true) Type getType()
The type of service offering. This property can be used to help filter packages.- See Also:
- SoftLayer_Product_Package::getType
-
-