CreateSubscriptionDetails

class oci.ons.models.CreateSubscriptionDetails(**kwargs)

Bases: object

The configuration details for creating the subscription.

__init__(**kwargs)

Initializes a new CreateSubscriptionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • topic_id (str) -- The value to assign to the topic_id property of this CreateSubscriptionDetails.
  • compartment_id (str) -- The value to assign to the compartment_id property of this CreateSubscriptionDetails.
  • protocol (str) -- The value to assign to the protocol property of this CreateSubscriptionDetails.
  • endpoint (str) -- The value to assign to the endpoint property of this CreateSubscriptionDetails.
  • metadata (str) -- The value to assign to the metadata property of this CreateSubscriptionDetails.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateSubscriptionDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateSubscriptionDetails.
compartment_id

[Required] Gets the compartment_id of this CreateSubscriptionDetails. The OCID of the compartment for the subscription.

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

Gets the defined_tags of this CreateSubscriptionDetails. 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 CreateSubscriptionDetails.
Return type:dict(str, dict(str, object))
endpoint

[Required] Gets the endpoint of this CreateSubscriptionDetails. 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. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Returns:The endpoint of this CreateSubscriptionDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this CreateSubscriptionDetails. 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 CreateSubscriptionDetails.
Return type:dict(str, str)
metadata

Gets the metadata of this CreateSubscriptionDetails. Metadata for the subscription.

Returns:The metadata of this CreateSubscriptionDetails.
Return type:str
protocol

[Required] Gets the protocol of this CreateSubscriptionDetails. The protocol used for the subscription.

Allowed values:
  • CUSTOM_HTTPS
  • EMAIL
  • HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
  • PAGERDUTY
  • SLACK

For information about subscription protocols, see To create a subscription.

Returns:The protocol of this CreateSubscriptionDetails.
Return type:str
topic_id

[Required] Gets the topic_id of this CreateSubscriptionDetails. The OCID of the topic for the subscription.

Returns:The topic_id of this CreateSubscriptionDetails.
Return type:str