CloudSubscriptionSummary¶

class oci.tenant_manager_control_plane.models.CloudSubscriptionSummary(**kwargs)¶

Bases: oci.tenant_manager_control_plane.models.subscription_summary.SubscriptionSummary

Summary of subscription.

Attributes

`ENTITY_VERSION_V1`	str(object=’’) -> str
`ENTITY_VERSION_V2`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary.
`compartment_id`	[Required] Gets the compartment_id of this SubscriptionSummary.
`currency_code`	[Required] Gets the currency_code of this CloudSubscriptionSummary.
`defined_tags`	[Required] Gets the defined_tags of this SubscriptionSummary.
`entity_version`	[Required] Gets the entity_version of this SubscriptionSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this SubscriptionSummary.
`id`	[Required] Gets the id of this SubscriptionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CloudSubscriptionSummary.
`service_name`	[Required] Gets the service_name of this SubscriptionSummary.
`subscription_number`	[Required] Gets the subscription_number of this CloudSubscriptionSummary.
`time_created`	[Required] Gets the time_created of this SubscriptionSummary.
`time_updated`	[Required] Gets the time_updated of this SubscriptionSummary.

Methods

`__init__`(**kwargs)	Initializes a new CloudSubscriptionSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENTITY_VERSION_V1 = 'V1'¶

ENTITY_VERSION_V2 = 'V2'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a CloudSubscriptionSummary. This constant has a value of “NEEDS_ATTENTION”

__init__(**kwargs)¶

Initializes a new CloudSubscriptionSummary object with values from keyword arguments. The default value of the entity_version attribute of this class is V2 and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

entity_version (str) – The value to assign to the entity_version property of this CloudSubscriptionSummary. Allowed values for this property are: “V1”, “V2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this CloudSubscriptionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this CloudSubscriptionSummary.
service_name (str) – The value to assign to the service_name property of this CloudSubscriptionSummary.
time_created (datetime) – The value to assign to the time_created property of this CloudSubscriptionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this CloudSubscriptionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CloudSubscriptionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CloudSubscriptionSummary.
subscription_number (str) – The value to assign to the subscription_number property of this CloudSubscriptionSummary.
currency_code (str) – The value to assign to the currency_code property of this CloudSubscriptionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CloudSubscriptionSummary. Allowed values for this property are: “NEEDS_ATTENTION”, “ACTIVE”, “INACTIVE”, “FAILED”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

compartment_id¶

[Required] Gets the compartment_id of this SubscriptionSummary. The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.

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

currency_code¶

[Required] Gets the currency_code of this CloudSubscriptionSummary. Currency code. For example USD, MXN.

Returns:	The currency_code of this CloudSubscriptionSummary.
Return type:	str

defined_tags¶

[Required] Gets the defined_tags of this SubscriptionSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this SubscriptionSummary.
Return type:	dict(str, dict(str, object))

entity_version¶

[Required] Gets the entity_version of this SubscriptionSummary. The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).

Allowed values for this property are: “V1”, “V2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The entity_version of this SubscriptionSummary.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this SubscriptionSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this SubscriptionSummary.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this SubscriptionSummary. The Oracle ID (OCID) of the subscription.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this CloudSubscriptionSummary. Lifecycle state of the subscription.

Allowed values for this property are: “NEEDS_ATTENTION”, “ACTIVE”, “INACTIVE”, “FAILED”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

service_name¶

[Required] Gets the service_name of this SubscriptionSummary. The type of subscription, such as ‘UCM’, ‘SAAS’, ‘ERP’, ‘CRM’.

Returns:	The service_name of this SubscriptionSummary.
Return type:	str

subscription_number¶

[Required] Gets the subscription_number of this CloudSubscriptionSummary. Unique Oracle Cloud Subscriptions identifier that is immutable on creation.

Returns:	The subscription_number of this CloudSubscriptionSummary.
Return type:	str

time_created¶

[Required] Gets the time_created of this SubscriptionSummary. The date and time of creation, as described in RFC 3339, section 14.29.

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

time_updated¶

[Required] Gets the time_updated of this SubscriptionSummary. The date and time of update, as described in RFC 3339, section 14.29.

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