Subscription

class oci.self.models.Subscription(**kwargs)

Bases: object

The model for a listing subscription.

Attributes:

LIFECYCLE_DETAILS_ACTIVE

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_CANCELED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_CREATED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_DELETED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_DELETING

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_EXPIRED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_FAILED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_PENDING_ACTIVATION

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_PENDING_CANCELLATION

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_PROVISIONING_COMPLETED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_PROVISIONING_FAILED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_PROVISIONING_STARTED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_SUSPENDED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_TERMINATED

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_DETAILS_UPDATING

A constant which can be used with the lifecycle_details property of a Subscription.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Subscription.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Subscription.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Subscription.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Subscription.

SOURCE_TYPE_OCI_NATIVE

A constant which can be used with the source_type property of a Subscription.

SOURCE_TYPE_THIRD_PARTY

A constant which can be used with the source_type property of a Subscription.

additional_details

Gets the additional_details of this Subscription.

compartment_id

[Required] Gets the compartment_id of this Subscription.

defined_tags

[Required] Gets the defined_tags of this Subscription.

display_name

[Required] Gets the display_name of this Subscription.

freeform_tags

[Required] Gets the freeform_tags of this Subscription.

id

[Required] Gets the id of this Subscription.

lifecycle_details

Gets the lifecycle_details of this Subscription.

lifecycle_state

[Required] Gets the lifecycle_state of this Subscription.

product_id

Gets the product_id of this Subscription.

realm

Gets the realm of this Subscription.

region

Gets the region of this Subscription.

seller_id

Gets the seller_id of this Subscription.

source_type

Gets the source_type of this Subscription.

subscription_details

Gets the subscription_details of this Subscription.

system_tags

Gets the system_tags of this Subscription.

tenant_id

[Required] Gets the tenant_id of this Subscription.

time_created

[Required] Gets the time_created of this Subscription.

time_ended

Gets the time_ended of this Subscription.

time_started

Gets the time_started of this Subscription.

time_updated

Gets the time_updated of this Subscription.

Methods:

__init__(**kwargs)

Initializes a new Subscription object with values from keyword arguments.

LIFECYCLE_DETAILS_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “ACTIVE”

LIFECYCLE_DETAILS_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “CANCELED”

LIFECYCLE_DETAILS_CREATED = 'CREATED'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “CREATED”

LIFECYCLE_DETAILS_DELETED = 'DELETED'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “DELETED”

LIFECYCLE_DETAILS_DELETING = 'DELETING'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “DELETING”

LIFECYCLE_DETAILS_EXPIRED = 'EXPIRED'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “EXPIRED”

LIFECYCLE_DETAILS_FAILED = 'FAILED'

A constant which can be used with the lifecycle_details property of a Subscription. 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 Subscription. 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 Subscription. 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 Subscription. 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 Subscription. 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 Subscription. 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 Subscription. This constant has a value of “SUSPENDED”

LIFECYCLE_DETAILS_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “TERMINATED”

LIFECYCLE_DETAILS_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_details property of a Subscription. This constant has a value of “UPDATING”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Subscription. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Subscription. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Subscription. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Subscription. This constant has a value of “INACTIVE”

SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'

A constant which can be used with the source_type property of a Subscription. This constant has a value of “OCI_NATIVE”

SOURCE_TYPE_THIRD_PARTY = 'THIRD_PARTY'

A constant which can be used with the source_type property of a Subscription. This constant has a value of “THIRD_PARTY”

__init__(**kwargs)

Initializes a new Subscription 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 Subscription.

  • display_name (str) – The value to assign to the display_name property of this Subscription.

  • compartment_id (str) – The value to assign to the compartment_id property of this Subscription.

  • tenant_id (str) – The value to assign to the tenant_id property of this Subscription.

  • subscription_details (oci.self.models.SubscriptionDetails) – The value to assign to the subscription_details property of this Subscription.

  • seller_id (str) – The value to assign to the seller_id property of this Subscription.

  • source_type (str) – The value to assign to the source_type property of this Subscription. Allowed values for this property are: “OCI_NATIVE”, “THIRD_PARTY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • product_id (str) – The value to assign to the product_id property of this Subscription.

  • additional_details (list[oci.self.models.ExtendedMetadata]) – The value to assign to the additional_details property of this Subscription.

  • realm (str) – The value to assign to the realm property of this Subscription.

  • region (str) – The value to assign to the region property of this Subscription.

  • time_created (datetime) – The value to assign to the time_created property of this Subscription.

  • time_updated (datetime) – The value to assign to the time_updated property of this Subscription.

  • time_started (datetime) – The value to assign to the time_started property of this Subscription.

  • time_ended (datetime) – The value to assign to the time_ended property of this Subscription.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this 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’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Subscription. 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 Subscription.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Subscription.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Subscription.

property additional_details

Gets the additional_details of this Subscription. Additional details that are specific for this subscription such as activation details.

Returns

The additional_details of this Subscription.

Return type

list[oci.self.models.ExtendedMetadata]

property compartment_id

[Required] Gets the compartment_id of this Subscription. The unique identifier for the compartment where the subscription was purchased.

Returns

The compartment_id of this Subscription.

Return type

str

property defined_tags

[Required] Gets the defined_tags of this Subscription. 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 Subscription.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this Subscription. The subscription name. Must be unique within the compartment. This value can be updated.

Returns

The display_name of this Subscription.

Return type

str

property freeform_tags

[Required] Gets the freeform_tags of this Subscription. 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 Subscription.

Return type

dict(str, str)

property id

[Required] Gets the id of this Subscription. The unique identifier for the subscription within a specific compartment.

Returns

The id of this Subscription.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Subscription. 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 Subscription.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Subscription. The current lifecycle 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 Subscription.

Return type

str

property product_id

Gets the product_id of this Subscription. The unique OCID of the product, effectively functioning as the listing ID.

Returns

The product_id of this Subscription.

Return type

str

property realm

Gets the realm of this Subscription. The realm from where customer is buying the subscription.

Returns

The realm of this Subscription.

Return type

str

property region

Gets the region of this Subscription. The region from where customer is buying the subscription.

Returns

The region of this Subscription.

Return type

str

property seller_id

Gets the seller_id of this Subscription. The OCID that identifies the seller within the platform.

Returns

The seller_id of this Subscription.

Return type

str

property source_type

Gets the source_type of this Subscription. The type of seller in SELF Service.

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

Returns

The source_type of this Subscription.

Return type

str

property subscription_details

Gets the subscription_details of this Subscription.

Returns

The subscription_details of this Subscription.

Return type

oci.self.models.SubscriptionDetails

property system_tags

Gets the system_tags of this Subscription. 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 Subscription.

Return type

dict(str, dict(str, object))

property tenant_id

[Required] Gets the tenant_id of this Subscription. The unique identifier for the tenant where the subscription was purchased.

Returns

The tenant_id of this Subscription.

Return type

str

property time_created

[Required] Gets the time_created of this Subscription. 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 Subscription.

Return type

datetime

property time_ended

Gets the time_ended of this Subscription. 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 Subscription.

Return type

datetime

property time_started

Gets the time_started of this Subscription. The date and time the Subscription was started, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_started of this Subscription.

Return type

datetime

property time_updated

Gets the time_updated of this Subscription. The date and time the Subscription was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns

The time_updated of this Subscription.

Return type

datetime