events.oracle.com/v1beta1¶
APIVersion: events.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes events.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Rule | Namespaced | Sample | - |
Rule¶
Manage OCI Events rules.
Plural:rulesScope:NamespacedAPIVersion:events.oracle.com/v1beta1Sample: Sample (config/samples/events_v1beta1_rule.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
RuleSpec defines the desired state of Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
RuleActions defines nested fields for Rule.Actions. | object |
Yes | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. | string |
Yes | - | - |
condition |
A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters: * Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {} For more examples, see Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). * For a condition with fields to match an event, the event must contain all the field names listed in the condition. Field names must appear in the condition with the same nesting structure used in the event. For a list of reference events, see Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). * Rules apply to events in the compartment in which you create them and any child compartments. This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments. * Wildcard matching is supported with the asterisk (*) character. For examples of wildcard matching, see Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) Example: \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" |
string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. | string |
No | - | - |
displayName |
A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. | string |
Yes | - | - |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
isEnabled |
Whether or not this rule is currently enabled. Example: true |
boolean |
Yes | - | - |
Spec.actions¶
RuleActions defines nested fields for Rule.Actions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
A list of one or more ActionDetails objects. | list[object] |
Yes | - | - |
Spec.actions.actions[]¶
RuleActionsAction defines nested fields for Rule.Actions.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionType |
- | string |
No | - | - |
description |
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. | string |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. | string |
No | - | - |
isEnabled |
Whether or not this action is currently enabled. Example: true |
boolean |
Yes | - | - |
jsonData |
- | string |
No | - | - |
streamId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. | string |
No | - | - |
topicId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. | string |
No | - | - |
Status¶
RuleStatus defines the observed state of Rule.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
RuleActions defines nested fields for Rule.Actions. | object |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. | string |
No | - | - |
condition |
A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters: * Fields not mentioned in the condition are ignored. You can create a valid filter that matches all events with two curly brackets: {} For more examples, see Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). * For a condition with fields to match an event, the event must contain all the field names listed in the condition. Field names must appear in the condition with the same nesting structure used in the event. For a list of reference events, see Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). * Rules apply to events in the compartment in which you create them and any child compartments. This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments. * Wildcard matching is supported with the asterisk (*) character. For examples of wildcard matching, see Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) Example: \"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\" |
string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
description |
A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. | string |
No | - | - |
displayName |
A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. Example: "This rule sends a notification upon completion of DbaaS backup." |
string |
No | - | - |
freeformTags |
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. | string |
No | - | - |
isEnabled |
Whether or not this rule is currently enabled. Example: true |
boolean |
No | - | - |
lifecycleMessage |
A message generated by the Events service about the current state of this rule. | string |
No | - | - |
lifecycleState |
The current state of the rule. | string |
No | - | - |
status |
- | object |
Yes | - | - |
timeCreated |
The time this rule was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. Example: 2018-09-12T22:47:12.613Z |
string |
No | - | - |
Status.actions¶
RuleActions defines nested fields for Rule.Actions.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actions |
A list of one or more ActionDetails objects. | list[object] |
Yes | - | - |
Status.actions.actions[]¶
RuleActionsAction defines nested fields for Rule.Actions.Action.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
actionType |
- | string |
No | - | - |
description |
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. | string |
No | - | - |
functionId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. | string |
No | - | - |
isEnabled |
Whether or not this action is currently enabled. Example: true |
boolean |
Yes | - | - |
jsonData |
- | string |
No | - | - |
streamId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. | string |
No | - | - |
topicId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. | string |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |