Package com.oracle.bmc.ccdoffers.model

Class CcdOffer.Builder

  • Enclosing class:
    CcdOffer
    public static class CcdOffer.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public CcdOffer.Builder id​(String id)
        The CCD offer OCID.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • displayName

        public CcdOffer.Builder displayName​(String displayName)
        The CCD offer name.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • sourceType

        public CcdOffer.Builder sourceType​(CcdOffer.SourceType sourceType)
        The commercial workflow that created the CCD offer/commitment.

        This value is immutable.

        Parameters:
        sourceType - the value to set
        Returns:
        this builder

      • reclaimTerm

        public CcdOffer.Builder reclaimTerm​(Long reclaimTerm)
        The reclaim term for an offer, measured in reclaimTermUnit.
        Parameters:
        reclaimTerm - the value to set
        Returns:
        this builder

      • reclaimTermUnit

        public CcdOffer.Builder reclaimTermUnit​(CcdOffer.ReclaimTermUnit reclaimTermUnit)
        The unit used to measure reclaimTerm.
        Parameters:
        reclaimTermUnit - the value to set
        Returns:
        this builder

      • lastUpdatedBy

        public CcdOffer.Builder lastUpdatedBy​(String lastUpdatedBy)
        Entity/User who lastly updated the ccdOffer.
        Parameters:
        lastUpdatedBy - the value to set
        Returns:
        this builder

      • createdBy

        public CcdOffer.Builder createdBy​(String createdBy)
        Entity/User who created the ccdOffer.
        Parameters:
        createdBy - the value to set
        Returns:
        this builder

      • orderDocumentNumber

        public CcdOffer.Builder orderDocumentNumber​(String orderDocumentNumber)
        Sales order document number.
        Parameters:
        orderDocumentNumber - the value to set
        Returns:
        this builder

      • customerSegment

        public CcdOffer.Builder customerSegment​(CcdOffer.CustomerSegment customerSegment)
        The targeted customer segment.
        Parameters:
        customerSegment - the value to set
        Returns:
        this builder

      • isFillerUsageEnable

        public CcdOffer.Builder isFillerUsageEnable​(Boolean isFillerUsageEnable)
        Enable or disable filler usage if the customer usage quantity is below the minimum quantity, and you want metering to fill in usages to meet the minimum quantity.
        Parameters:
        isFillerUsageEnable - the value to set
        Returns:
        this builder

      • reportingRegion

        public CcdOffer.Builder reportingRegion​(String reportingRegion)
        Defines where the filler usage is reported
        Parameters:
        reportingRegion - the value to set
        Returns:
        this builder

      • sku

        public CcdOffer.Builder sku​(String sku)
        The SKU part number (prefaced with “B”) the CCD is associated with.
        Parameters:
        sku - the value to set
        Returns:
        this builder

      • skuDisplayName

        public CcdOffer.Builder skuDisplayName​(String skuDisplayName)
        The canonical SKU display name.
        Parameters:
        skuDisplayName - the value to set
        Returns:
        this builder

      • skuMetric

        public CcdOffer.Builder skuMetric​(String skuMetric)
        The canonical billing metric.
        Parameters:
        skuMetric - the value to set
        Returns:
        this builder

      • minQuantity

        public CcdOffer.Builder minQuantity​(Long minQuantity)
        The minimum quantity of the primary SKU committed to the CCD offer.

        For FLEX offers, minQuantity and maxQuantity must both be equal if maxQuantity provided.

        Parameters:
        minQuantity - the value to set
        Returns:
        this builder

      • maxQuantity

        public CcdOffer.Builder maxQuantity​(Long maxQuantity)
        The maximum quantity of the primary SKU committed to the CCD offer.

        For FLEX offers if provided, it must equal minQuantity.

        Parameters:
        maxQuantity - the value to set
        Returns:
        this builder

      • term

        public CcdOffer.Builder term​(Integer term)
        The number of terms the offer is applicable to.
        Parameters:
        term - the value to set
        Returns:
        this builder

      • discountPct

        public CcdOffer.Builder discountPct​(String discountPct)
        The discount percentage applicable to the CCD offer, represented as a decimal string from 0 through 100 inclusive.
        Parameters:
        discountPct - the value to set
        Returns:
        this builder

      • externalPriceOfSku

        public CcdOffer.Builder externalPriceOfSku​(List<SkuExternalPriceModel> externalPriceOfSku)
        The SKU list price in all currency codes.
        Parameters:
        externalPriceOfSku - the value to set
        Returns:
        this builder

      • bundleSkus

        public CcdOffer.Builder bundleSkus​(List<BundleSku> bundleSkus)
        The polymorphic bundled SKU definitions.

        Every bundled SKU in an offer must use the same quantityRule; don’t mix FIXED_RATIO and CUSTOMER_SELECTED bundled SKUs in one offer. An offer can contain at most five SKUs in total, including the primary SKU.

        Parameters:
        bundleSkus - the value to set
        Returns:
        this builder

      • lifecycleState

        public CcdOffer.Builder lifecycleState​(CcdOffer.LifecycleState lifecycleState)
        Always defaults to Active.

        For the accurate resource state, refer to the lifecycleDetails property value.

        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public CcdOffer.Builder lifecycleDetails​(CcdOffer.LifecycleDetails lifecycleDetails)
        The CCD offer’s detailed current state.

        The state value is determined by timeCcdOfferStarts, timeCcdOfferEnds, and timeTerminated with respect to the current time.

        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • timeCreated

        public CcdOffer.Builder timeCreated​(Date timeCreated)
        Date and time the CCD was created.

        The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeTerminated

        public CcdOffer.Builder timeTerminated​(Date timeTerminated)
        Date and time the CCD was terminated.

        The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

        Parameters:
        timeTerminated - the value to set
        Returns:
        this builder

      • timeUpdated

        public CcdOffer.Builder timeUpdated​(Date timeUpdated)
        Date and time the CCD was updated lastly.

        The format is defined by RFC 3339. Example: 2025-01-25T21:10:29.600Z

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • freeformTags

        public CcdOffer.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public CcdOffer.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public CcdOffer.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder

      • timeCcdOfferStarts

        public CcdOffer.Builder timeCcdOfferStarts​(Date timeCcdOfferStarts)
        The inclusive date the CCD offer will be effective.

        The format is defined by RFC 3339.

        Parameters:
        timeCcdOfferStarts - the value to set
        Returns:
        this builder

      • timeCcdOfferEnds

        public CcdOffer.Builder timeCcdOfferEnds​(Date timeCcdOfferEnds)
        The inclusive time when the CCD offer is no longer in effect, and must be after timeCcdOfferStarts.

        The format is defined by RFC 3339.

        Parameters:
        timeCcdOfferEnds - the value to set
        Returns:
        this builder

      • currencyCode

        public CcdOffer.Builder currencyCode​(String currencyCode)
        Currency code of listPrice associated with primary product/sku.

        This will be always null. Please refer externalPriceOfSku to know product/sku’s associated list price in its currency code.

        Parameters:
        currencyCode - the value to set
        Returns:
        this builder

      • listPrice

        public CcdOffer.Builder listPrice​(String listPrice)
        ListPrice of a sku.

        Please refer externalPriceOfSku to know product/sku’s associated list price in its currency code.

        Parameters:
        listPrice - the value to set
        Returns:
        this builder

      • subscriptionId

        public CcdOffer.Builder subscriptionId​(String subscriptionId)
        The subscription OCID if a this is dedicated CCD offer for a customer.
        Parameters:
        subscriptionId - the value to set
        Returns:
        this builder

      • compartmentId

        public CcdOffer.Builder compartmentId​(String compartmentId)
        The root compartment OCID of the customer’s tenancy if offer is dedicated to a particular customer only.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder