ons.oracle.com/v1beta1
Back to API Reference
APIVersion: ons.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 ons.oracle.com/v1beta1.
Resources
Subscription
Manage OCI Notifications subscriptions.
Plural: subscriptionsScope: NamespacedAPIVersion: ons.oracle.com/v1beta1Sample: Sample (config/samples/ons_v1beta1_subscription.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
SubscriptionSpec defines the desired state of Subscription.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription. |
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 |
- |
- |
deliveryPolicy |
The delivery policy of the subscription. Stored as a JSON string. |
object |
No |
- |
- |
endpoint |
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information. For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub). |
string |
Yes |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
metadata |
Metadata for the subscription. |
string |
No |
- |
- |
protocol |
The protocol used for the subscription. Allowed values: * CUSTOM_HTTPS * EMAIL * HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) * ORACLE_FUNCTIONS * PAGERDUTY * SLACK * SMS For information about subscription protocols, see To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub). |
string |
Yes |
- |
- |
topicId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic for the subscription. |
string |
Yes |
- |
- |
Spec.deliveryPolicy
Back to Subscription spec
The delivery policy of the subscription. Stored as a JSON string.
| Field |
Description |
Type |
Required |
Default |
Enum |
backoffRetryPolicy |
SubscriptionDeliveryPolicyBackoffRetryPolicy defines nested fields for Subscription.DeliveryPolicy.BackoffRetryPolicy. |
object |
No |
- |
- |
Spec.deliveryPolicy.backoffRetryPolicy
Back to Subscription spec
SubscriptionDeliveryPolicyBackoffRetryPolicy defines nested fields for Subscription.DeliveryPolicy.BackoffRetryPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
maxRetryDuration |
The maximum retry duration in milliseconds. Default value is 7200000 (2 hours). |
integer |
Yes |
- |
- |
policyType |
The type of delivery policy. |
string |
Yes |
- |
- |
Status
SubscriptionStatus defines the observed state of Subscription.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription. |
string |
No |
- |
- |
createdTime |
The time when this suscription was created. |
integer (int64) |
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 |
- |
- |
deliverPolicy |
The delivery policy of the subscription. Stored as a JSON string. |
string |
No |
- |
- |
deliveryPolicy |
SubscriptionDeliveryPolicy defines nested fields for Subscription.DeliveryPolicy. |
object |
No |
- |
- |
endpoint |
A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. |
string |
No |
- |
- |
etag |
For optimistic concurrency control. See if-match. |
string |
No |
- |
- |
freeformTags |
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 (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 the subscription. |
string |
No |
- |
- |
lifecycleState |
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE. |
string |
No |
- |
- |
protocol |
The protocol used for the subscription. Allowed values: * CUSTOM_HTTPS * EMAIL * HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) * ORACLE_FUNCTIONS * PAGERDUTY * SLACK * SMS For information about subscription protocols, see To create a subscription (https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub). |
string |
No |
- |
- |
status |
- |
object |
Yes |
- |
- |
topicId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic. |
string |
No |
- |
- |
Status.deliveryPolicy
Back to Subscription status
SubscriptionDeliveryPolicy defines nested fields for Subscription.DeliveryPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
backoffRetryPolicy |
SubscriptionDeliveryPolicyBackoffRetryPolicy defines nested fields for Subscription.DeliveryPolicy.BackoffRetryPolicy. |
object |
No |
- |
- |
Status.deliveryPolicy.backoffRetryPolicy
Back to Subscription status
SubscriptionDeliveryPolicyBackoffRetryPolicy defines nested fields for Subscription.DeliveryPolicy.BackoffRetryPolicy.
| Field |
Description |
Type |
Required |
Default |
Enum |
maxRetryDuration |
The maximum retry duration in milliseconds. Default value is 7200000 (2 hours). |
integer |
Yes |
- |
- |
policyType |
The type of delivery policy. |
string |
Yes |
- |
- |
Status.status
Back to Subscription 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
Back to Subscription status
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
Back to Subscription status
| 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[]
Back to Subscription status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |
Topic
Manage OCI Notifications topics.
Plural: topicsScope: NamespacedAPIVersion: ons.oracle.com/v1beta1Sample: Sample (config/samples/ons_v1beta1_topic.yaml)Packages: Not currently exposed by a customer-visible package.
Spec
TopicSpec defines the desired state of Topic.
| Field |
Description |
Type |
Required |
Default |
Enum |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the topic in. |
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 |
The description of the topic being created. Avoid entering confidential information. |
string |
No |
- |
- |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
- |
- |
name |
The name of the topic being created. The topic name must be unique across the tenancy. Avoid entering confidential information. |
string |
Yes |
- |
- |
Status
TopicStatus defines the observed state of Topic.
| Field |
Description |
Type |
Required |
Default |
Enum |
status |
- |
object |
Yes |
- |
- |
Status.status
Back to Topic 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
Back to Topic status
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
Back to Topic status
| 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[]
Back to Topic status
| Field |
Description |
Type |
Required |
Default |
Enum |
lastTransitionTime |
- |
string (date-time) |
No |
- |
- |
message |
- |
string |
No |
- |
- |
reason |
- |
string |
No |
- |
- |
status |
- |
string |
Yes |
- |
- |
type |
- |
string |
Yes |
- |
- |