SubscriptionSummary¶
- class oci.ons.models.SubscriptionSummary(**kwargs)¶
Bases:
objectThe subscription’s configuration summary.
Attributes:
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.
Gets the created_time of this SubscriptionSummary.
Gets the defined_tags of this SubscriptionSummary.
Gets the delivery_policy of this SubscriptionSummary.
[Required] Gets the endpoint of this SubscriptionSummary.
Gets the etag of this SubscriptionSummary.
Gets the freeform_tags of this SubscriptionSummary.
[Required] Gets the id of this SubscriptionSummary.
[Required] Gets the lifecycle_state of this SubscriptionSummary.
[Required] Gets the protocol of this SubscriptionSummary.
[Required] Gets the topic_id of this SubscriptionSummary.
Methods:
__init__(**kwargs)Initializes a new SubscriptionSummary object with values from keyword arguments.
- 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_PENDING = 'PENDING'¶
A constant which can be used with the lifecycle_state property of a SubscriptionSummary. This constant has a value of “PENDING”
- __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.
topic_id (str) – The value to assign to the topic_id property of this SubscriptionSummary.
protocol (str) – The value to assign to the protocol property of this SubscriptionSummary.
endpoint (str) – The value to assign to the endpoint 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: “PENDING”, “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this SubscriptionSummary.
created_time (int) – The value to assign to the created_time property of this SubscriptionSummary.
delivery_policy (oci.ons.models.DeliveryPolicy) – The value to assign to the delivery_policy property of this SubscriptionSummary.
etag (str) – The value to assign to the etag property of this SubscriptionSummary.
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.
- property compartment_id¶
[Required] Gets the compartment_id of this SubscriptionSummary. The OCID of the compartment for the subscription.
- Returns
The compartment_id of this SubscriptionSummary.
- Return type
str
- property created_time¶
Gets the created_time of this SubscriptionSummary. The time when this suscription was created.
- Returns
The created_time of this SubscriptionSummary.
- Return type
int
- property defined_tags¶
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 delivery_policy¶
Gets the delivery_policy of this SubscriptionSummary.
- Returns
The delivery_policy of this SubscriptionSummary.
- Return type
- property endpoint¶
[Required] Gets the endpoint of this SubscriptionSummary. A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol.
- Returns
The endpoint of this SubscriptionSummary.
- Return type
str
- property etag¶
Gets the etag of this SubscriptionSummary. For optimistic concurrency control. See if-match.
- Returns
The etag of this SubscriptionSummary.
- Return type
str
- property freeform_tags¶
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 OCID of the subscription.
- Returns
The id of this SubscriptionSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this SubscriptionSummary. The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
Allowed values for this property are: “PENDING”, “ACTIVE”, “DELETED”, ‘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 protocol¶
[Required] Gets the protocol of this SubscriptionSummary. The protocol used for the subscription.
- Allowed values:
CUSTOM_HTTPS
EMAIL
HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
ORACLE_FUNCTIONS
PAGERDUTY
SLACK
SMS
For information about subscription protocols, see To create a subscription.
- Returns
The protocol of this SubscriptionSummary.
- Return type
str