Events Functions

CHANGE_RULE_COMPARTMENT Function

Moves a rule into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_rule_compartment (
  rule_id varchar2,
  change_rule_compartment_details dbms_cloud_oci_events_change_rule_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_change_rule_compartment_response_t;

Parameters

Parameter	Description
`rule_id`	(required) The OCID of this rule.
`change_rule_compartment_details`	(required)
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_RULE Function

Creates a new rule.

Syntax

FUNCTION create_rule (
  create_rule_details dbms_cloud_oci_events_create_rule_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_create_rule_response_t;

Parameters

Parameter	Description
`create_rule_details`	(required) Specification of the rule to create
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RULE Function

Deletes a rule.

Syntax

FUNCTION delete_rule (
  rule_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_delete_rule_response_t;

Parameters

Parameter	Description
`rule_id`	(required) The OCID of this rule.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RULE Function

Retrieves a rule.

Syntax

FUNCTION get_rule (
  rule_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_get_rule_response_t;

Parameters

Parameter	Description
`rule_id`	(required) The OCID of this rule.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RULES Function

Lists rules for this compartment.

Syntax

FUNCTION list_rules (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_list_rules_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment to which this rule belongs.
`limit`	(optional) The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10
`page`	(optional) For list pagination. The value of the opc-next-page response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`lifecycle_state`	(optional) A filter to return only rules that match the lifecycle state in this parameter. Example: `Creating`
`display_name`	(optional) A filter to return only rules with descriptions that match the displayName string in this parameter. Example: `\"This rule sends a notification upon completion of DbaaS backup.\"`
`sort_by`	(optional) Specifies the attribute with which to sort the rules. Default: `timeCreated` * TIME_CREATED: Sorts by timeCreated. * DISPLAY_NAME: Sorts by displayName. * ID: Sorts by id. Allowed values are: 'TIME_CREATED', 'ID', 'DISPLAY_NAME'
`sort_order`	(optional) Specifies sort order. * ASC: Ascending sort order. * DESC: Descending sort order. Allowed values are: 'ASC', 'DESC'
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RULE Function

Updates a rule.

Syntax

FUNCTION update_rule (
  rule_id varchar2,
  update_rule_details dbms_cloud_oci_events_update_rule_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ev_events_update_rule_response_t;

Parameters

Parameter	Description
`rule_id`	(required) The OCID of this rule.
`update_rule_details`	(required) The new rule spec to apply
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://events.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_RULE_COMPARTMENT Function

CREATE_RULE Function

DELETE_RULE Function

GET_RULE Function

LIST_RULES Function

UPDATE_RULE Function