Action¶
- class oci.events.models.Action(**kwargs)¶
Bases:
objectAn object that represents an action to trigger for events that match a rule.
Attributes:
A constant which can be used with the action_type property of a Action.
A constant which can be used with the action_type property of a Action.
A constant which can be used with the action_type property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
A constant which can be used with the lifecycle_state property of a Action.
[Required] Gets the action_type of this Action.
Gets the description of this Action.
[Required] Gets the id of this Action.
Gets the is_enabled of this Action.
[Required] Gets the lifecycle_message of this Action.
[Required] Gets the lifecycle_state of this Action.
Methods:
__init__(**kwargs)Initializes a new Action 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.
- ACTION_TYPE_FAAS = 'FAAS'¶
A constant which can be used with the action_type property of a Action. This constant has a value of “FAAS”
- ACTION_TYPE_ONS = 'ONS'¶
A constant which can be used with the action_type property of a Action. This constant has a value of “ONS”
- ACTION_TYPE_OSS = 'OSS'¶
A constant which can be used with the action_type property of a Action. This constant has a value of “OSS”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Action. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Action 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
action_type (str) – The value to assign to the action_type property of this Action. Allowed values for this property are: “ONS”, “OSS”, “FAAS”, ‘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 Action.
lifecycle_message (str) – The value to assign to the lifecycle_message property of this Action.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Action. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_enabled (bool) – The value to assign to the is_enabled property of this Action.
description (str) – The value to assign to the description property of this Action.
- property action_type¶
[Required] Gets the action_type of this Action. The action to perform if the condition in the rule matches an event.
ONS: Send to an Oracle Notification Service topic.
OSS: Send to a stream from Oracle Streaming Service.
FAAS: Send to an Oracle Functions Service endpoint.
Allowed values for this property are: “ONS”, “OSS”, “FAAS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The action_type of this Action.
- Return type
str
- property description¶
Gets the description of this Action. A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information.
- Returns
The description of this Action.
- Return type
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.
- property id¶
[Required] Gets the id of this Action. The OCID of the action.
- Returns
The id of this Action.
- Return type
str
- property is_enabled¶
Gets the is_enabled of this Action. Whether or not this action is currently enabled.
Example: true
- Returns
The is_enabled of this Action.
- Return type
bool
- property lifecycle_message¶
[Required] Gets the lifecycle_message of this Action. A message generated by the Events service about the current state of this action.
- Returns
The lifecycle_message of this Action.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Action. The current state of the rule.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “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 Action.
- Return type
str