SubscriptionSummary¶
- class oci.self.models.SubscriptionSummary(**kwargs)¶
Bases:
objectThe model for a summary of a subscription.
Attributes:
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_details property of a SubscriptionSummary.
A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
A constant which can be used with the lifecycle_state property of a SubscriptionSummary.
[Required] Gets the compartment_id of this SubscriptionSummary.
[Required] Gets the defined_tags of this SubscriptionSummary.
[Required] Gets the display_name of this SubscriptionSummary.
[Required] Gets the freeform_tags of this SubscriptionSummary.
[Required] Gets the id of this SubscriptionSummary.
[Required] Gets the lifecycle_details of this SubscriptionSummary.
Gets the lifecycle_state of this SubscriptionSummary.
Gets the product_id of this SubscriptionSummary.
Gets the seller_id of this SubscriptionSummary.
Gets the subscription_details of this SubscriptionSummary.
Gets the system_tags of this SubscriptionSummary.
[Required] Gets the tenant_id of this SubscriptionSummary.
[Required] Gets the time_created of this SubscriptionSummary.
Gets the time_ended of this SubscriptionSummary.
Gets the time_started of this SubscriptionSummary.
Gets the time_updated of this SubscriptionSummary.
Methods:
__init__(**kwargs)Initializes a new SubscriptionSummary object with values from keyword arguments.
- LIFECYCLE_DETAILS_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_DETAILS_CANCELED = 'CANCELED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “CANCELED”
- LIFECYCLE_DETAILS_CREATED = 'CREATED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “CREATED”
- LIFECYCLE_DETAILS_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “DELETED”
- LIFECYCLE_DETAILS_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “DELETING”
- LIFECYCLE_DETAILS_EXPIRED = 'EXPIRED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “EXPIRED”
- LIFECYCLE_DETAILS_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “FAILED”
- LIFECYCLE_DETAILS_PENDING_ACTIVATION = 'PENDING_ACTIVATION'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “PENDING_ACTIVATION”
- LIFECYCLE_DETAILS_PENDING_CANCELLATION = 'PENDING_CANCELLATION'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “PENDING_CANCELLATION”
- LIFECYCLE_DETAILS_PROVISIONING_COMPLETED = 'PROVISIONING_COMPLETED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “PROVISIONING_COMPLETED”
- LIFECYCLE_DETAILS_PROVISIONING_FAILED = 'PROVISIONING_FAILED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “PROVISIONING_FAILED”
- LIFECYCLE_DETAILS_PROVISIONING_STARTED = 'PROVISIONING_STARTED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “PROVISIONING_STARTED”
- LIFECYCLE_DETAILS_SUSPENDED = 'SUSPENDED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “SUSPENDED”
- LIFECYCLE_DETAILS_TERMINATED = 'TERMINATED'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “TERMINATED”
- LIFECYCLE_DETAILS_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_details property of a SubscriptionSummary. This constant has a value of “UPDATING”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “INACTIVE”
- __init__(**kwargs)¶
Initializes a new SubscriptionSummary 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 SubscriptionSummary.
display_name (str) – The value to assign to the display_name property of this SubscriptionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this SubscriptionSummary.
tenant_id (str) – The value to assign to the tenant_id property of this SubscriptionSummary.
subscription_details (oci.self.models.SubscriptionDetails) – The value to assign to the subscription_details property of this SubscriptionSummary.
seller_id (str) – The value to assign to the seller_id property of this SubscriptionSummary.
product_id (str) – The value to assign to the product_id property of this SubscriptionSummary.
time_created (datetime) – The value to assign to the time_created property of this SubscriptionSummary.
time_updated (datetime) – The value to assign to the time_updated property of this SubscriptionSummary.
time_started (datetime) – The value to assign to the time_started property of this SubscriptionSummary.
time_ended (datetime) – The value to assign to the time_ended property of this SubscriptionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SubscriptionSummary. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SubscriptionSummary. Allowed values for this property are: “CREATED”, “PENDING_ACTIVATION”, “PROVISIONING_STARTED”, “PROVISIONING_COMPLETED”, “PROVISIONING_FAILED”, “ACTIVE”, “EXPIRED”, “TERMINATED”, “FAILED”, “DELETING”, “UPDATING”, “DELETED”, “PENDING_CANCELLATION”, “SUSPENDED”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SubscriptionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SubscriptionSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SubscriptionSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this SubscriptionSummary. The unique identifier for the compartment where subscription was created.
- Returns
The compartment_id of this SubscriptionSummary.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this SubscriptionSummary. 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 SubscriptionSummary.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this SubscriptionSummary. The subscription name. Must be unique within the compartment. This value can be updated.
- Returns
The display_name of this SubscriptionSummary.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this SubscriptionSummary. 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 SubscriptionSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this SubscriptionSummary. The unique identifier for the subscription within a specific compartment.
- Returns
The id of this SubscriptionSummary.
- Return type
str
- property lifecycle_details¶
[Required] Gets the lifecycle_details of this SubscriptionSummary. A message that describes the current state of the Subscription in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
Allowed values for this property are: “CREATED”, “PENDING_ACTIVATION”, “PROVISIONING_STARTED”, “PROVISIONING_COMPLETED”, “PROVISIONING_FAILED”, “ACTIVE”, “EXPIRED”, “TERMINATED”, “FAILED”, “DELETING”, “UPDATING”, “DELETED”, “PENDING_CANCELLATION”, “SUSPENDED”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_details of this SubscriptionSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this SubscriptionSummary. The current state of the Subscription.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this SubscriptionSummary.
- Return type
str
- property product_id¶
Gets the product_id of this SubscriptionSummary. The unique OCID of the product, effectively functioning as the listing ID.
- Returns
The product_id of this SubscriptionSummary.
- Return type
str
- property seller_id¶
Gets the seller_id of this SubscriptionSummary. The OCID that identifies the seller within the platform.
- Returns
The seller_id of this SubscriptionSummary.
- Return type
str
- property subscription_details¶
Gets the subscription_details of this SubscriptionSummary.
- Returns
The subscription_details of this SubscriptionSummary.
- Return type
- property system_tags¶
Gets the system_tags of this SubscriptionSummary. 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 SubscriptionSummary.
- Return type
dict(str, dict(str, object))
- property tenant_id¶
[Required] Gets the tenant_id of this SubscriptionSummary. The unique identifier for the tenant where the subscription was purchased.
- Returns
The tenant_id of this SubscriptionSummary.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this SubscriptionSummary. The date and time the Subscription was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this SubscriptionSummary.
- Return type
datetime
- property time_ended¶
Gets the time_ended of this SubscriptionSummary. The date and time the Subscription was ended, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_ended of this SubscriptionSummary.
- Return type
datetime