Package com.ibm.cloud.platform_services.global_catalog.v1.model

Class PricingGet

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class PricingGet
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Pricing-related information.

    • Method Detail

      • getDeploymentId

        public java.lang.String getDeploymentId()
        Gets the deploymentId. The deployment object id this pricing is from. Only set if object kind is deployment.
        Returns:
        the deploymentId

      • getDeploymentLocation

        public java.lang.String getDeploymentLocation()
        Gets the deploymentLocation. The deployment location this pricing is from. Only set if object kind is deployment.
        Returns:
        the deploymentLocation

      • getDeploymentRegion

        public java.lang.String getDeploymentRegion()
        Gets the deploymentRegion. If price is for a deployment object then the region in the pricing catalog of the deployment object will be here. To be valid, this value must be contained within deployment_regions.
        Returns:
        the deploymentRegion

      • isDeploymentLocationNoPriceAvailable

        public java.lang.Boolean isDeploymentLocationNoPriceAvailable()
        Gets the deploymentLocationNoPriceAvailable. Is the location price not available. Only set in api /pricing/deployment and only set if true. This means for the given deployment object there was no pricing set in pricing catalog.
        Returns:
        the deploymentLocationNoPriceAvailable

      • getType

        public java.lang.String getType()
        Gets the type. Type of plan. Valid values are `free`, `trial`, `paygo`, `paid`, `subscription`.
        Returns:
        the type

      • getOrigin

        public java.lang.String getOrigin()
        Gets the origin. Defines where the pricing originates.
        Returns:
        the origin

      • getStartingPrice

        public StartingPrice getStartingPrice()
        Gets the startingPrice. Plan-specific starting price information.
        Returns:
        the startingPrice

      • getMetrics

        public java.util.List<Metrics> getMetrics()
        Gets the metrics. Plan-specific cost metric structure.
        Returns:
        the metrics

      • getDeploymentRegions

        public java.util.List<java.lang.String> getDeploymentRegions()
        Gets the deploymentRegions. List of regions where region pricing is available. Only set on global deployments if enabled by owner.
        Returns:
        the deploymentRegions

      • getEffectiveFrom

        public java.util.Date getEffectiveFrom()
        Gets the effectiveFrom. The start date-time indicating when this pricing plan takes effect.
        Returns:
        the effectiveFrom

      • getEffectiveUntil

        public java.util.Date getEffectiveUntil()
        Gets the effectiveUntil. The end date-time indicating when this pricing plan is no longer in effect.
        Returns:
        the effectiveUntil

      • isRequireLogin

        public java.lang.Boolean isRequireLogin()
        Gets the requireLogin. Boolean value indicating whether or not this pricing plan requires login to get pricing data.
        Returns:
        the requireLogin

      • getPricingCatalogUrl

        public java.lang.String getPricingCatalogUrl()
        Gets the pricingCatalogUrl. URL to the entry for this plan on the pricing catalog.
        Returns:
        the pricingCatalogUrl

      • getSalesAvenue

        public java.util.List<java.lang.String> getSalesAvenue()
        Gets the salesAvenue. Tags describing how this plan was purchased (catalog [default], seller, private offer). Currently only settable on MCSP subscription plans.
        Returns:
        the salesAvenue