CcdCommitmentSummary¶

class oci.ccd_offers.models.CcdCommitmentSummary(**kwargs)¶

Bases: object

The CCD commitment summary.

Methods

__init__(**kwargs) Initializes a new CcdCommitmentSummary object with values from keyword arguments.

Attributes

`approved_by`	Gets the approved_by of this CcdCommitmentSummary.
`compartment_id`	[Required] Gets the compartment_id of this CcdCommitmentSummary.
`created_by`	Gets the created_by of this CcdCommitmentSummary.
`defined_tags`	Gets the defined_tags of this CcdCommitmentSummary.
`display_name`	Gets the display_name of this CcdCommitmentSummary.
`filler_tenancy_home_region`	Gets the filler_tenancy_home_region of this CcdCommitmentSummary.
`filler_tenancy_id`	Gets the filler_tenancy_id of this CcdCommitmentSummary.
`freeform_tags`	Gets the freeform_tags of this CcdCommitmentSummary.
`id`	[Required] Gets the id of this CcdCommitmentSummary.
`last_updated_by`	Gets the last_updated_by of this CcdCommitmentSummary.
`lifecycle_details`	[Required] Gets the lifecycle_details of this CcdCommitmentSummary.
`lifecycle_state`	Gets the lifecycle_state of this CcdCommitmentSummary.
`offer_id`	[Required] Gets the offer_id of this CcdCommitmentSummary.
`quantity`	[Required] Gets the quantity of this CcdCommitmentSummary.
`reclaim_term`	Gets the reclaim_term of this CcdCommitmentSummary.
`reclaim_term_unit`	Gets the reclaim_term_unit of this CcdCommitmentSummary.
`secondary_skus`	Gets the secondary_skus of this CcdCommitmentSummary.
`sku_quantity_price_model`	Gets the sku_quantity_price_model of this CcdCommitmentSummary.
`source_type`	Gets the source_type of this CcdCommitmentSummary.
`subscription_id`	[Required] Gets the subscription_id of this CcdCommitmentSummary.
`system_tags`	Gets the system_tags of this CcdCommitmentSummary.
`time_ccd_commitment_ends`	[Required] Gets the time_ccd_commitment_ends of this CcdCommitmentSummary.
`time_ccd_commitment_starts`	[Required] Gets the time_ccd_commitment_starts of this CcdCommitmentSummary.
`time_created`	Gets the time_created of this CcdCommitmentSummary.
`time_terminated`	Gets the time_terminated of this CcdCommitmentSummary.
`time_updated`	Gets the time_updated of this CcdCommitmentSummary.
`usage_eligibility`	Gets the usage_eligibility of this CcdCommitmentSummary.

__init__(**kwargs)¶

Initializes a new CcdCommitmentSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this CcdCommitmentSummary.
quantity (int) – The value to assign to the quantity property of this CcdCommitmentSummary.
offer_id (str) – The value to assign to the offer_id property of this CcdCommitmentSummary.
source_type (str) – The value to assign to the source_type property of this CcdCommitmentSummary.
reclaim_term (int) – The value to assign to the reclaim_term property of this CcdCommitmentSummary.
reclaim_term_unit (str) – The value to assign to the reclaim_term_unit property of this CcdCommitmentSummary.
display_name (str) – The value to assign to the display_name property of this CcdCommitmentSummary.
time_ccd_commitment_starts (datetime) – The value to assign to the time_ccd_commitment_starts property of this CcdCommitmentSummary.
time_ccd_commitment_ends (datetime) – The value to assign to the time_ccd_commitment_ends property of this CcdCommitmentSummary.
subscription_id (str) – The value to assign to the subscription_id property of this CcdCommitmentSummary.
compartment_id (str) – The value to assign to the compartment_id property of this CcdCommitmentSummary.
filler_tenancy_id (str) – The value to assign to the filler_tenancy_id property of this CcdCommitmentSummary.
filler_tenancy_home_region (str) – The value to assign to the filler_tenancy_home_region property of this CcdCommitmentSummary.
usage_eligibility (oci.ccd_offers.models.UsageEligibility) – The value to assign to the usage_eligibility property of this CcdCommitmentSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CcdCommitmentSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CcdCommitmentSummary.
sku_quantity_price_model (list[oci.ccd_offers.models.CommittedSkuQuantityPriceModel]) – The value to assign to the sku_quantity_price_model property of this CcdCommitmentSummary.
secondary_skus (list[oci.ccd_offers.models.SecondarySkus]) – The value to assign to the secondary_skus property of this CcdCommitmentSummary.
time_created (datetime) – The value to assign to the time_created property of this CcdCommitmentSummary.
time_updated (datetime) – The value to assign to the time_updated property of this CcdCommitmentSummary.
time_terminated (datetime) – The value to assign to the time_terminated property of this CcdCommitmentSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CcdCommitmentSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CcdCommitmentSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CcdCommitmentSummary.
last_updated_by (str) – The value to assign to the last_updated_by property of this CcdCommitmentSummary.
created_by (str) – The value to assign to the created_by property of this CcdCommitmentSummary.
approved_by (str) – The value to assign to the approved_by property of this CcdCommitmentSummary.

approved_by¶

Gets the approved_by of this CcdCommitmentSummary. Entity/User who approved the ccdCommitment.

Returns:	The approved_by of this CcdCommitmentSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CcdCommitmentSummary. The root compartment ID associated with the CCD offer the customer has signed up for.

Returns:	The compartment_id of this CcdCommitmentSummary.
Return type:	str

created_by¶

Gets the created_by of this CcdCommitmentSummary. The entity that created the CCD commitment.

Returns:	The created_by of this CcdCommitmentSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this CcdCommitmentSummary. 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 defined_tags of this CcdCommitmentSummary.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CcdCommitmentSummary. The CCD commitment name. The name will be unique across the subscription for which the CCD commitment has been created. Avoid entering confidential information.

Returns:	The display_name of this CcdCommitmentSummary.
Return type:	str

filler_tenancy_home_region¶

Gets the filler_tenancy_home_region of this CcdCommitmentSummary. The filler tenancy home region.

Returns:	The filler_tenancy_home_region of this CcdCommitmentSummary.
Return type:	str

filler_tenancy_id¶

Gets the filler_tenancy_id of this CcdCommitmentSummary. The tenancy OCID that you want to apply filler usage to.

Returns:	The filler_tenancy_id of this CcdCommitmentSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CcdCommitmentSummary. 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 freeform_tags of this CcdCommitmentSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this CcdCommitmentSummary. The CCD commitment resource OCID.

Returns:	The id of this CcdCommitmentSummary.
Return type:	str

last_updated_by¶

Gets the last_updated_by of this CcdCommitmentSummary. Entity/User who lastly updated the ccdCommitment.

Returns:	The last_updated_by of this CcdCommitmentSummary.
Return type:	str

lifecycle_details¶

[Required] Gets the lifecycle_details of this CcdCommitmentSummary. The CCD commitment’s current state. A commitment that’s expected to get a dedicated capacity will be in the Awaiting Provisioning state unless the commitment is ended or canceled. Otherwise, the value is determined by timeCcdCommitmentStarts, timeCcdCommitmentEnds, and timeTerminated, with respect to the current time.

Returns:	The lifecycle_details of this CcdCommitmentSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this CcdCommitmentSummary. The CCD commitment’s current state, which always defaults to Active. For a more accurate detailed state, refer to lifecycleDetails.

Returns:	The lifecycle_state of this CcdCommitmentSummary.
Return type:	str

offer_id¶

[Required] Gets the offer_id of this CcdCommitmentSummary. The CCD offer OCID.

Returns:	The offer_id of this CcdCommitmentSummary.
Return type:	str

quantity¶

[Required] Gets the quantity of this CcdCommitmentSummary. The hourly quantity that the customer is committing to a CCD offer’s main SKU. For example, if the quantity is 1000, then you are committing to a 1000 usage quantity value per hour.

Returns:	The quantity of this CcdCommitmentSummary.
Return type:	int

reclaim_term¶

Gets the reclaim_term of this CcdCommitmentSummary. The reclaim term copied from the offer when the commitment is created. The value is measured in reclaimTermUnit.

Returns:	The reclaim_term of this CcdCommitmentSummary.
Return type:	int

reclaim_term_unit¶

Gets the reclaim_term_unit of this CcdCommitmentSummary. The unit used to measure reclaimTerm, copied from the offer when the commitment is created.

Returns:	The reclaim_term_unit of this CcdCommitmentSummary.
Return type:	str

secondary_skus¶

Gets the secondary_skus of this CcdCommitmentSummary. The secondary SKUs associated with the main SKU.

Returns:	The secondary_skus of this CcdCommitmentSummary.
Return type:	list[oci.ccd_offers.models.SecondarySkus]

sku_quantity_price_model¶

Gets the sku_quantity_price_model of this CcdCommitmentSummary. The list of SKUs associated with the commitment and their prices in all currency codes.

Returns:	The sku_quantity_price_model of this CcdCommitmentSummary.
Return type:	list[oci.ccd_offers.models.CommittedSkuQuantityPriceModel]

source_type¶

Gets the source_type of this CcdCommitmentSummary. The commercial workflow of the associated CCD offer.

Returns:	The source_type of this CcdCommitmentSummary.
Return type:	str

subscription_id¶

[Required] Gets the subscription_id of this CcdCommitmentSummary. The subscription OCID the CCD commitment is applicable to.

Returns:	The subscription_id of this CcdCommitmentSummary.
Return type:	str

system_tags¶

Gets the system_tags of this CcdCommitmentSummary. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this CcdCommitmentSummary.
Return type:	dict(str, dict(str, object))

time_ccd_commitment_ends¶

[Required] Gets the time_ccd_commitment_ends of this CcdCommitmentSummary. The date and time the CCD commitment ends, which is calculated from the timeCcdCommitmentStarts of the ccdCommitment, the term, and ccdOffer units. The format must conform to RFC 3339.

Returns:	The time_ccd_commitment_ends of this CcdCommitmentSummary.
Return type:	datetime

time_ccd_commitment_starts¶

[Required] Gets the time_ccd_commitment_starts of this CcdCommitmentSummary. The date and time, rounded down to an hour, that the CCD commitment will be effective. The format conforms to RFC 3339.

Returns:	The time_ccd_commitment_starts of this CcdCommitmentSummary.
Return type:	datetime

time_created¶

Gets the time_created of this CcdCommitmentSummary. Date and time the CCD was created. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns:	The time_created of this CcdCommitmentSummary.
Return type:	datetime

time_terminated¶

Gets the time_terminated of this CcdCommitmentSummary. Date and time the CCD was terminated. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns:	The time_terminated of this CcdCommitmentSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this CcdCommitmentSummary. Date and time the CCD was updated lastly. The format is defined by RFC 3339. Example: 2025-01-25T21:10:29.600Z

Returns:	The time_updated of this CcdCommitmentSummary.
Return type:	datetime

usage_eligibility¶

Gets the usage_eligibility of this CcdCommitmentSummary.

Returns:	The usage_eligibility of this CcdCommitmentSummary.
Return type:	oci.ccd_offers.models.UsageEligibility