Subscription

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

Bases: object

Base subscription type, which carries shared properties for any subscription version.

Attributes

ENTITY_VERSION_V1 A constant which can be used with the entity_version property of a Subscription.
ENTITY_VERSION_V2 A constant which can be used with the entity_version property of a Subscription.
compartment_id [Required] Gets the compartment_id of this Subscription.
defined_tags [Required] Gets the defined_tags of this Subscription.
entity_version [Required] Gets the entity_version of this Subscription.
freeform_tags [Required] Gets the freeform_tags of this Subscription.
id [Required] Gets the id of this Subscription.
service_name [Required] Gets the service_name of this Subscription.
time_created [Required] Gets the time_created of this Subscription.
time_updated [Required] Gets the time_updated of this Subscription.

Methods

__init__(**kwargs) Initializes a new Subscription 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'

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

ENTITY_VERSION_V2 = 'V2'

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

__init__(**kwargs)

Initializes a new Subscription object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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

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

Returns:The compartment_id of this Subscription.
Return type:str
defined_tags

[Required] Gets the defined_tags of this Subscription. 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 Subscription.
Return type:dict(str, dict(str, object))
entity_version

[Required] Gets the entity_version of this Subscription. 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 Subscription.
Return type:str
freeform_tags

[Required] Gets the freeform_tags of this Subscription. 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 Subscription.
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 Subscription. The Oracle ID (OCID) of the subscription.

Returns:The id of this Subscription.
Return type:str
service_name

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

Returns:The service_name of this Subscription.
Return type:str
time_created

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

Returns:The time_created of this Subscription.
Return type:datetime
time_updated

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

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