StreamingServiceAction¶

class oci.events.models.StreamingServiceAction(**kwargs)¶

Bases: oci.events.models.action.Action

An action that delivers to an Oracle Stream Service stream.

Attributes

`ACTION_TYPE_FAAS`	str(object=’’) -> str
`ACTION_TYPE_ONS`	str(object=’’) -> str
`ACTION_TYPE_OSS`	str(object=’’) -> str
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_INACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`action_type`	[Required] Gets the action_type of this Action.
`description`	Gets the description of this Action.
`id`	[Required] Gets the id of this Action.
`is_enabled`	Gets the is_enabled of this Action.
`lifecycle_message`	[Required] Gets the lifecycle_message of this Action.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Action.
`stream_id`	Gets the stream_id of this StreamingServiceAction.

Methods

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

ACTION_TYPE_ONS = 'ONS'¶

ACTION_TYPE_OSS = 'OSS'¶

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

__init__(**kwargs)¶

Initializes a new StreamingServiceAction object with values from keyword arguments. The default value of the action_type attribute of this class is OSS and it should not be changed. 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 StreamingServiceAction. Allowed values for this property are: “ONS”, “OSS”, “FAAS”
id (str) – The value to assign to the id property of this StreamingServiceAction.
lifecycle_message (str) – The value to assign to the lifecycle_message property of this StreamingServiceAction.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StreamingServiceAction. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”
is_enabled (bool) – The value to assign to the is_enabled property of this StreamingServiceAction.
description (str) – The value to assign to the description property of this StreamingServiceAction.
stream_id (str) – The value to assign to the stream_id property of this StreamingServiceAction.

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

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.

id¶

[Required] Gets the id of this Action. The OCID of the action.

Returns:	The id of this Action.
Return type:	str

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

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

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

stream_id¶

Gets the stream_id of this StreamingServiceAction. The OCID of the stream to which messages are delivered.

Returns:	The stream_id of this StreamingServiceAction.
Return type:	str