Package com.oracle.bmc.onesubscription.model

Class SubscribedService.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public SubscribedService.Builder id​(String id)
        SPM (Subscription Plan Management) internal Subscribed Service ID
        Parameters:
        id - the value to set
        Returns:
        this builder

      • serialNumber

        public SubscribedService.Builder serialNumber​(String serialNumber)
        Subscribed service line number.
        Parameters:
        serialNumber - the value to set
        Returns:
        this builder

      • subscriptionId

        public SubscribedService.Builder subscriptionId​(String subscriptionId)
        Subscription ID associated with the subscribed service.
        Parameters:
        subscriptionId - the value to set
        Returns:
        this builder

      • timeStart

        public SubscribedService.Builder timeStart​(Date timeStart)
        Subscribed service start date.
        Parameters:
        timeStart - the value to set
        Returns:
        this builder

      • timeEnd

        public SubscribedService.Builder timeEnd​(Date timeEnd)
        Subscribed service end date.
        Parameters:
        timeEnd - the value to set
        Returns:
        this builder

      • quantity

        public SubscribedService.Builder quantity​(String quantity)
        Subscribed service quantity.
        Parameters:
        quantity - the value to set
        Returns:
        this builder

      • status

        public SubscribedService.Builder status​(String status)
        Subscribed service status.
        Parameters:
        status - the value to set
        Returns:
        this builder

      • operationType

        public SubscribedService.Builder operationType​(String operationType)
        Subscribed service operation type.
        Parameters:
        operationType - the value to set
        Returns:
        this builder

      • netUnitPrice

        public SubscribedService.Builder netUnitPrice​(String netUnitPrice)
        Subscribed service net unit price.
        Parameters:
        netUnitPrice - the value to set
        Returns:
        this builder

      • pricePeriod

        public SubscribedService.Builder pricePeriod​(String pricePeriod)
        Indicates the period for which the commitment amount can be utilized, exceeding which, the amount lapses.

        Also used in calculation of total contract line value.

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

      • lineNetAmount

        public SubscribedService.Builder lineNetAmount​(String lineNetAmount)
        Subscribed service line net amount.
        Parameters:
        lineNetAmount - the value to set
        Returns:
        this builder

      • isVariableCommitment

        public SubscribedService.Builder isVariableCommitment​(Boolean isVariableCommitment)
        Indicates if the commitment lines can have different quantities.
        Parameters:
        isVariableCommitment - the value to set
        Returns:
        this builder

      • isAllowance

        public SubscribedService.Builder isAllowance​(Boolean isAllowance)
        Indicates if a service can recieve usages and consequently have the available amounts computed.
        Parameters:
        isAllowance - the value to set
        Returns:
        this builder

      • usedAmount

        public SubscribedService.Builder usedAmount​(String usedAmount)
        Subscribed service used amount.
        Parameters:
        usedAmount - the value to set
        Returns:
        this builder

      • availableAmount

        public SubscribedService.Builder availableAmount​(String availableAmount)
        Subscribed sercice available or remaining amount.
        Parameters:
        availableAmount - the value to set
        Returns:
        this builder

      • fundedAllocationValue

        public SubscribedService.Builder fundedAllocationValue​(String fundedAllocationValue)
        Funded allocation line value.

        Example: 12000.00

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

      • isHavingUsage

        public SubscribedService.Builder isHavingUsage​(Boolean isHavingUsage)
        Indicates whether or not there has been usage for the subscribed service.
        Parameters:
        isHavingUsage - the value to set
        Returns:
        this builder

      • isCapToPriceList

        public SubscribedService.Builder isCapToPriceList​(Boolean isCapToPriceList)
        If true compares rate between the rate card and the active price list, and the minimum rate would be fetched.
        Parameters:
        isCapToPriceList - the value to set
        Returns:
        this builder

      • creditPercentage

        public SubscribedService.Builder creditPercentage​(String creditPercentage)
        Subscribed service credit percentage.
        Parameters:
        creditPercentage - the value to set
        Returns:
        this builder

      • partnerTransactionType

        public SubscribedService.Builder partnerTransactionType​(String partnerTransactionType)
        Contains the name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.
        Parameters:
        partnerTransactionType - the value to set
        Returns:
        this builder

      • isCreditEnabled

        public SubscribedService.Builder isCreditEnabled​(Boolean isCreditEnabled)
        Used in context of service credit lines.
        Parameters:
        isCreditEnabled - the value to set
        Returns:
        this builder

      • overagePolicy

        public SubscribedService.Builder overagePolicy​(String overagePolicy)
        Overage policy of subscribed service.
        Parameters:
        overagePolicy - the value to set
        Returns:
        this builder

      • overageBillTo

        public SubscribedService.Builder overageBillTo​(String overageBillTo)
        Overage bill to of subscribed service.
        Parameters:
        overageBillTo - the value to set
        Returns:
        this builder

      • paygPolicy

        public SubscribedService.Builder paygPolicy​(String paygPolicy)
        Pay As You Go policy of the subscribed service.

        Can be null, indicating no PAYG policy.

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

      • promoOrderLineId

        public SubscribedService.Builder promoOrderLineId​(Long promoOrderLineId)
        Not null if this service has an associated promotion line in SPM (Subscription Plan Management).

        Contains the line identifier from order management of the associated promo line.

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

      • promotionPricingType

        public SubscribedService.Builder promotionPricingType​(String promotionPricingType)
        Promotion pricing type of subscribed service.

        Can be null, indicating no promotional pricing.

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

      • rateCardDiscountPercentage

        public SubscribedService.Builder rateCardDiscountPercentage​(String rateCardDiscountPercentage)
        Subscribed service rate card discount percentage.
        Parameters:
        rateCardDiscountPercentage - the value to set
        Returns:
        this builder

      • overageDiscountPercentage

        public SubscribedService.Builder overageDiscountPercentage​(String overageDiscountPercentage)
        Subscribed service overage discount percentage.
        Parameters:
        overageDiscountPercentage - the value to set
        Returns:
        this builder

      • paymentNumber

        public SubscribedService.Builder paymentNumber​(String paymentNumber)
        Payment number of the subscribed service.
        Parameters:
        paymentNumber - the value to set
        Returns:
        this builder

      • timePaymentExpiry

        public SubscribedService.Builder timePaymentExpiry​(Date timePaymentExpiry)
        Subscribed service payment expiration date.
        Parameters:
        timePaymentExpiry - the value to set
        Returns:
        this builder

      • paymentMethod

        public SubscribedService.Builder paymentMethod​(String paymentMethod)
        Payment method of the subscribed service.
        Parameters:
        paymentMethod - the value to set
        Returns:
        this builder

      • transactionExtensionId

        public SubscribedService.Builder transactionExtensionId​(Long transactionExtensionId)
        Subscribed service transaction extension ID.
        Parameters:
        transactionExtensionId - the value to set
        Returns:
        this builder

      • salesChannel

        public SubscribedService.Builder salesChannel​(String salesChannel)
        Sales channel of the subscribed service.
        Parameters:
        salesChannel - the value to set
        Returns:
        this builder

      • eligibleToRenew

        public SubscribedService.Builder eligibleToRenew​(String eligibleToRenew)
        Subscribed service eligible to renew field.
        Parameters:
        eligibleToRenew - the value to set
        Returns:
        this builder

      • renewedSubscribedServiceId

        public SubscribedService.Builder renewedSubscribedServiceId​(String renewedSubscribedServiceId)
        SPM (Subscription Plan Management) renewed subscription ID.
        Parameters:
        renewedSubscribedServiceId - the value to set
        Returns:
        this builder

      • termValue

        public SubscribedService.Builder termValue​(Long termValue)
        Term value in months.
        Parameters:
        termValue - the value to set
        Returns:
        this builder

      • termValueUom

        public SubscribedService.Builder termValueUom​(String termValueUom)
        Term value UOM (Unit of Measure).
        Parameters:
        termValueUom - the value to set
        Returns:
        this builder

      • renewalOptyId

        public SubscribedService.Builder renewalOptyId​(Long renewalOptyId)
        Subscribed service opportunity ID.
        Parameters:
        renewalOptyId - the value to set
        Returns:
        this builder

      • renewalOptyNumber

        public SubscribedService.Builder renewalOptyNumber​(String renewalOptyNumber)
        Renewal opportunity number of the subscribed service.
        Parameters:
        renewalOptyNumber - the value to set
        Returns:
        this builder

      • renewalOptyType

        public SubscribedService.Builder renewalOptyType​(String renewalOptyType)
        Renewal opportunity type of the subscribed service.
        Parameters:
        renewalOptyType - the value to set
        Returns:
        this builder

      • bookingOptyNumber

        public SubscribedService.Builder bookingOptyNumber​(String bookingOptyNumber)
        Booking opportunity number of the subscribed service.
        Parameters:
        bookingOptyNumber - the value to set
        Returns:
        this builder

      • revenueLineId

        public SubscribedService.Builder revenueLineId​(Long revenueLineId)
        Subscribed service revenue line ID.
        Parameters:
        revenueLineId - the value to set
        Returns:
        this builder

      • revenueLineNumber

        public SubscribedService.Builder revenueLineNumber​(String revenueLineNumber)
        Revenue line number of the subscribed service.
        Parameters:
        revenueLineNumber - the value to set
        Returns:
        this builder

      • majorSet

        public SubscribedService.Builder majorSet​(Long majorSet)
        Subscribed service major set.
        Parameters:
        majorSet - the value to set
        Returns:
        this builder

      • timeMajorsetStart

        public SubscribedService.Builder timeMajorsetStart​(Date timeMajorsetStart)
        Subscribed service major set start date.
        Parameters:
        timeMajorsetStart - the value to set
        Returns:
        this builder

      • timeMajorsetEnd

        public SubscribedService.Builder timeMajorsetEnd​(Date timeMajorsetEnd)
        Subscribed service major set end date.
        Parameters:
        timeMajorsetEnd - the value to set
        Returns:
        this builder

      • systemArrInLc

        public SubscribedService.Builder systemArrInLc​(String systemArrInLc)
        Subscribed service system ARR (Annualized Recurring Revenue).
        Parameters:
        systemArrInLc - the value to set
        Returns:
        this builder

      • systemArrInSc

        public SubscribedService.Builder systemArrInSc​(String systemArrInSc)
        Subscribed service system ARR in standard currency.
        Parameters:
        systemArrInSc - the value to set
        Returns:
        this builder

      • systemAtrArrInLc

        public SubscribedService.Builder systemAtrArrInLc​(String systemAtrArrInLc)
        Subscribed service system ATR-ARR (Annualized Recurring Revenue - Available to Renew).
        Parameters:
        systemAtrArrInLc - the value to set
        Returns:
        this builder

      • systemAtrArrInSc

        public SubscribedService.Builder systemAtrArrInSc​(String systemAtrArrInSc)
        Subscribed service system ATR-ARR in standard currency.
        Parameters:
        systemAtrArrInSc - the value to set
        Returns:
        this builder

      • revisedArrInLc

        public SubscribedService.Builder revisedArrInLc​(String revisedArrInLc)
        Subscribed service revised ARR.
        Parameters:
        revisedArrInLc - the value to set
        Returns:
        this builder

      • revisedArrInSc

        public SubscribedService.Builder revisedArrInSc​(String revisedArrInSc)
        Subscribed service revised ARR in standard currency.
        Parameters:
        revisedArrInSc - the value to set
        Returns:
        this builder

      • totalValue

        public SubscribedService.Builder totalValue​(String totalValue)
        Subscribed service total value.
        Parameters:
        totalValue - the value to set
        Returns:
        this builder

      • originalPromoAmount

        public SubscribedService.Builder originalPromoAmount​(String originalPromoAmount)
        Subscribed service promotion amount.
        Parameters:
        originalPromoAmount - the value to set
        Returns:
        this builder

      • orderHeaderId

        public SubscribedService.Builder orderHeaderId​(Long orderHeaderId)
        Sales order header associated to the subscribed service.
        Parameters:
        orderHeaderId - the value to set
        Returns:
        this builder

      • orderNumber

        public SubscribedService.Builder orderNumber​(Long orderNumber)
        Sales order number associated to the subscribed service.
        Parameters:
        orderNumber - the value to set
        Returns:
        this builder

      • orderType

        public SubscribedService.Builder orderType​(String orderType)
        Order type of subscribed service.
        Parameters:
        orderType - the value to set
        Returns:
        this builder

      • orderLineId

        public SubscribedService.Builder orderLineId​(Long orderLineId)
        Sales order line ID associated with the subscribed service.
        Parameters:
        orderLineId - the value to set
        Returns:
        this builder

      • orderLineNumber

        public SubscribedService.Builder orderLineNumber​(Integer orderLineNumber)
        Sales order line number associated with the subscribed service.
        Parameters:
        orderLineNumber - the value to set
        Returns:
        this builder

      • commitmentScheduleId

        public SubscribedService.Builder commitmentScheduleId​(String commitmentScheduleId)
        Subscribed service commitment schedule ID.
        Parameters:
        commitmentScheduleId - the value to set
        Returns:
        this builder

      • salesAccountPartyId

        public SubscribedService.Builder salesAccountPartyId​(Long salesAccountPartyId)
        Subscribed service sales account party ID.
        Parameters:
        salesAccountPartyId - the value to set
        Returns:
        this builder

      • dataCenter

        public SubscribedService.Builder dataCenter​(String dataCenter)
        Subscribed service data center.
        Parameters:
        dataCenter - the value to set
        Returns:
        this builder

      • dataCenterRegion

        public SubscribedService.Builder dataCenterRegion​(String dataCenterRegion)
        Subscribed service data center region.
        Parameters:
        dataCenterRegion - the value to set
        Returns:
        this builder

      • adminEmail

        public SubscribedService.Builder adminEmail​(String adminEmail)
        Subscribed service admin email ID.
        Parameters:
        adminEmail - the value to set
        Returns:
        this builder

      • buyerEmail

        public SubscribedService.Builder buyerEmail​(String buyerEmail)
        Subscribed service buyer email ID.
        Parameters:
        buyerEmail - the value to set
        Returns:
        this builder

      • subscriptionSource

        public SubscribedService.Builder subscriptionSource​(String subscriptionSource)
        Subscribed service source.
        Parameters:
        subscriptionSource - the value to set
        Returns:
        this builder

      • provisioningSource

        public SubscribedService.Builder provisioningSource​(String provisioningSource)
        Subscribed service provisioning source.
        Parameters:
        provisioningSource - the value to set
        Returns:
        this builder

      • fulfillmentSet

        public SubscribedService.Builder fulfillmentSet​(String fulfillmentSet)
        Subscribed service fulfillment set.
        Parameters:
        fulfillmentSet - the value to set
        Returns:
        this builder

      • isIntentToPay

        public SubscribedService.Builder isIntentToPay​(Boolean isIntentToPay)
        Subscribed service intent to pay parameter.
        Parameters:
        isIntentToPay - the value to set
        Returns:
        this builder

      • isPayg

        public SubscribedService.Builder isPayg​(Boolean isPayg)
        Subscribed service PAYG parameter.
        Parameters:
        isPayg - the value to set
        Returns:
        this builder

      • pricingModel

        public SubscribedService.Builder pricingModel​(String pricingModel)
        Subscribed service pricing model.
        Parameters:
        pricingModel - the value to set
        Returns:
        this builder

      • programType

        public SubscribedService.Builder programType​(String programType)
        Subscribed service program type.
        Parameters:
        programType - the value to set
        Returns:
        this builder

      • startDateType

        public SubscribedService.Builder startDateType​(String startDateType)
        Subscribed service start date type.
        Parameters:
        startDateType - the value to set
        Returns:
        this builder

      • timeProvisioned

        public SubscribedService.Builder timeProvisioned​(Date timeProvisioned)
        Subscribed service provisioning date.
        Parameters:
        timeProvisioned - the value to set
        Returns:
        this builder

      • promoType

        public SubscribedService.Builder promoType​(String promoType)
        Subscribed service promotion type.
        Parameters:
        promoType - the value to set
        Returns:
        this builder

      • csi

        public SubscribedService.Builder csi​(Long csi)
        Subscribed service CSI number.
        Parameters:
        csi - the value to set
        Returns:
        this builder

      • customerTransactionReference

        public SubscribedService.Builder customerTransactionReference​(String customerTransactionReference)
        Identifier for a customer’s transactions, for purchase of any Oracle services.
        Parameters:
        customerTransactionReference - the value to set
        Returns:
        this builder

      • partnerCreditAmount

        public SubscribedService.Builder partnerCreditAmount​(String partnerCreditAmount)
        Subscribed service partner credit amount.
        Parameters:
        partnerCreditAmount - the value to set
        Returns:
        this builder

      • isSingleRateCard

        public SubscribedService.Builder isSingleRateCard​(Boolean isSingleRateCard)
        Indicates if the subscribed service has a single rate card.
        Parameters:
        isSingleRateCard - the value to set
        Returns:
        this builder

      • agreementId

        public SubscribedService.Builder agreementId​(Long agreementId)
        Subscribed service agreement ID.
        Parameters:
        agreementId - the value to set
        Returns:
        this builder

      • agreementName

        public SubscribedService.Builder agreementName​(String agreementName)
        Subscribed service agreement name.
        Parameters:
        agreementName - the value to set
        Returns:
        this builder

      • agreementType

        public SubscribedService.Builder agreementType​(String agreementType)
        Subscribed service agreement type.
        Parameters:
        agreementType - the value to set
        Returns:
        this builder

      • billingFrequency

        public SubscribedService.Builder billingFrequency​(String billingFrequency)
        Subscribed service invoice frequency.
        Parameters:
        billingFrequency - the value to set
        Returns:
        this builder

      • timeWelcomeEmailSent

        public SubscribedService.Builder timeWelcomeEmailSent​(Date timeWelcomeEmailSent)
        Subscribed service welcome email sent date.
        Parameters:
        timeWelcomeEmailSent - the value to set
        Returns:
        this builder

      • timeServiceConfigurationEmailSent

        public SubscribedService.Builder timeServiceConfigurationEmailSent​(Date timeServiceConfigurationEmailSent)
        Subscribed service configuration email sent date.
        Parameters:
        timeServiceConfigurationEmailSent - the value to set
        Returns:
        this builder

      • timeCustomerConfig

        public SubscribedService.Builder timeCustomerConfig​(Date timeCustomerConfig)
        Subscribed service customer configuration date.
        Parameters:
        timeCustomerConfig - the value to set
        Returns:
        this builder

      • timeAgreementEnd

        public SubscribedService.Builder timeAgreementEnd​(Date timeAgreementEnd)
        Subscribed service agreement end date.
        Parameters:
        timeAgreementEnd - the value to set
        Returns:
        this builder

      • commitmentServices

        public SubscribedService.Builder commitmentServices​(List<CommitmentService> commitmentServices)
        List of commitment services of a line.
        Parameters:
        commitmentServices - the value to set
        Returns:
        this builder

      • timeCreated

        public SubscribedService.Builder timeCreated​(Date timeCreated)
        Subscribed service creation date.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • createdBy

        public SubscribedService.Builder createdBy​(String createdBy)
        User that created the subscribed service.
        Parameters:
        createdBy - the value to set
        Returns:
        this builder

      • timeUpdated

        public SubscribedService.Builder timeUpdated​(Date timeUpdated)
        Subscribed service last update date.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • updatedBy

        public SubscribedService.Builder updatedBy​(String updatedBy)
        User that updated the subscribed service.
        Parameters:
        updatedBy - the value to set
        Returns:
        this builder

      • ratecardType

        public SubscribedService.Builder ratecardType​(String ratecardType)
        SPM (Subscription Plan Management) rate card type.
        Parameters:
        ratecardType - the value to set
        Returns:
        this builder