NotificationTopic

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

Bases: object

The properties that define a topic. For general information about topics, see Notifications Overview.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a NotificationTopic. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a NotificationTopic. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a NotificationTopic. This constant has a value of "DELETING"

__init__(**kwargs)

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

Parameters:
  • name (str) -- The value to assign to the name property of this NotificationTopic.
  • topic_id (str) -- The value to assign to the topic_id property of this NotificationTopic.
  • compartment_id (str) -- The value to assign to the compartment_id property of this NotificationTopic.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this NotificationTopic. Allowed values for this property are: "ACTIVE", "DELETING", "CREATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • description (str) -- The value to assign to the description property of this NotificationTopic.
  • time_created (datetime) -- The value to assign to the time_created property of this NotificationTopic.
  • etag (str) -- The value to assign to the etag property of this NotificationTopic.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this NotificationTopic.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this NotificationTopic.
  • api_endpoint (str) -- The value to assign to the api_endpoint property of this NotificationTopic.
api_endpoint

[Required] Gets the api_endpoint of this NotificationTopic. The endpoint for managing topic subscriptions or publishing messages to the topic.

Returns:The api_endpoint of this NotificationTopic.
Return type:str
compartment_id

[Required] Gets the compartment_id of this NotificationTopic. The OCID of the compartment for the topic.

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

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

Gets the description of this NotificationTopic. The description of the topic.

Returns:The description of this NotificationTopic.
Return type:str
etag

Gets the etag of this NotificationTopic. For optimistic concurrency control. See if-match.

Returns:The etag of this NotificationTopic.
Return type:str
freeform_tags

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

[Required] Gets the lifecycle_state of this NotificationTopic. The lifecycle state of the topic.

Allowed values for this property are: "ACTIVE", "DELETING", "CREATING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this NotificationTopic.
Return type:str
name

[Required] Gets the name of this NotificationTopic. The name of the topic.

Returns:The name of this NotificationTopic.
Return type:str
time_created

[Required] Gets the time_created of this NotificationTopic. The time the topic was created.

Returns:The time_created of this NotificationTopic.
Return type:datetime
topic_id

[Required] Gets the topic_id of this NotificationTopic. The OCID of the topic.

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