Package com.oracle.bmc.ccdoffers.model

Class CcdOfferSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240601")
public final class CcdOfferSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    CCD offer details.
    Note: Objects should always be created or deserialized using the CcdOfferSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CcdOfferSummary.Builder, which maintain a set of all explicitly set fields called CcdOfferSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The CCD offer resource OCID.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The CCD offer name.

        Avoid entering confidential information.

        Returns:
        the value

      • getSubscriptionId

        public String getSubscriptionId()
        The subscription OCID for which the dedicated CCD offer has been created.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The root compartment OCID of the customer’s tenancy.
        Returns:
        the value

      • getSourceType

        public CcdOffer.SourceType getSourceType()
        The commercial workflow that created the CCD offer.
        Returns:
        the value

      • getReclaimTerm

        public Long getReclaimTerm()
        The reclaim term for an offer, measured in reclaimTermUnit.
        Returns:
        the value

      • getReclaimTermUnit

        public CcdOffer.ReclaimTermUnit getReclaimTermUnit()
        The unit used to measure reclaimTerm.
        Returns:
        the value

      • getIsFillerUsageEnable

        public Boolean getIsFillerUsageEnable()
        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.
        Returns:
        the value

      • getLastUpdatedBy

        public String getLastUpdatedBy()
        Entity/User who lastly updated the ccdOffer.
        Returns:
        the value

      • getCreatedBy

        public String getCreatedBy()
        Entity/User who created the ccdOffer.
        Returns:
        the value

      • getOrderDocumentNumber

        public String getOrderDocumentNumber()
        Sales order document number.
        Returns:
        the value

      • getReportingRegion

        public String getReportingRegion()
        Defines where the filler usage is reported
        Returns:
        the value

      • getSku

        public String getSku()
        The SKU part number (prefaced with “B”) the CCD is associated with.
        Returns:
        the value

      • getSkuDisplayName

        public String getSkuDisplayName()
        The canonical SKU display name.
        Returns:
        the value

      • getSkuMetric

        public String getSkuMetric()
        The canonical billing metric.
        Returns:
        the value

      • getMinQuantity

        public Long getMinQuantity()
        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.

        Returns:
        the value

      • getMaxQuantity

        public Long getMaxQuantity()
        The maximum quantity of the primary SKU committed to the CCD offer.

        For FLEX offers if provided, it must equal minQuantity.

        Returns:
        the value

      • getTerm

        public Integer getTerm()
        The number of terms the offer is applicable to.
        Returns:
        the value

      • getDiscountPct

        public String getDiscountPct()
        The discount percentage applicable to the CCD offer, represented as a decimal string from 0 through 100 inclusive.
        Returns:
        the value

      • getBundleSkus

        public List<BundleSku> getBundleSkus()
        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.

        Returns:
        the value

      • getExternalPriceOfSku

        public List<SkuExternalPriceModel> getExternalPriceOfSku()
        The SKU list price in all currency codes.
        Returns:
        the value

      • getLifecycleState

        public CcdOffer.LifecycleState getLifecycleState()
        The CCD offer’s current state.

        This always defaults to Active. For the accurate resource state, refer to the lifecycleDetails property value.

        Returns:
        the value

      • getLifecycleDetails

        public CcdOffer.LifecycleDetails getLifecycleDetails()
        The CCD offer’s detailed current state.

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

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the CCD was created.

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

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        Date and time the CCD was updated lastly.

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

        Returns:
        the value

      • getTimeTerminated

        public Date getTimeTerminated()
        Date and time the CCD was terminated.

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

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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"}

        Returns:
        the value

      • getDefinedTags

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

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

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

        Returns:
        the value

      • getSystemTags

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

        Each key is predefined and scoped to a namespace.

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

        Returns:
        the value

      • getTimeCcdOfferStarts

        public Date getTimeCcdOfferStarts()
        The inclusive date the CCD offer will be effective.

        The format is defined by RFC 3339.

        Returns:
        the value

      • getTimeCcdOfferEnds

        public Date getTimeCcdOfferEnds()
        The inclusive time when the CCD offer is no longer in effect.

        The format is defined by RFC 3339.

        Returns:
        the value

      • getCurrencyCode

        public String getCurrencyCode()
        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.

        Returns:
        the value

      • getListPrice

        public String getListPrice()
        ListPrice of a sku.

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

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel