announcementsservice.oracle.com/v1beta1¶
APIVersion: announcementsservice.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 announcementsservice.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| AnnouncementSubscription | Namespaced | Sample | - |
AnnouncementSubscription¶
AnnouncementSubscription is the Schema for the announcementsubscriptions API.
Plural:announcementsubscriptionsScope:NamespacedAPIVersion:announcementsservice.oracle.com/v1beta1Sample: Sample (config/samples/announcementsservice_v1beta1_announcementsubscription.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
AnnouncementSubscriptionSpec defines the desired state of AnnouncementSubscription.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the announcement subscription. | string |
Yes | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
A description of the announcement subscription. Avoid entering confidential information. | string |
No | - | - |
displayName |
A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
Yes | - | - |
filterGroups |
A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes. | map[string, object] |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
onsTopicId |
The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see Details for Notifications (https://docs.oracle.com/iaas/Content/Identity/policyreference/notificationpolicyreference.htm). | string |
Yes | - | - |
preferredLanguage |
(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. | string |
No | - | - |
preferredTimeZone |
The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles | string |
No | - | - |
Spec.filterGroups{}¶
Back to AnnouncementSubscription spec
AnnouncementSubscriptionFilterGroups defines nested fields for AnnouncementSubscription.FilterGroups.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filters |
A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. | list[object] |
Yes | - | - |
Spec.filterGroups{}.filters[]¶
Back to AnnouncementSubscription spec
AnnouncementSubscriptionFilterGroupsFilter defines nested fields for AnnouncementSubscription.FilterGroups.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
type |
The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. | string |
Yes | - | - |
value |
The value of the filter. | string |
Yes | - | - |
Status¶
AnnouncementSubscriptionStatus defines the observed state of AnnouncementSubscription.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
compartmentId |
The OCID of the compartment that contains the announcement subscription. | string |
No | - | - |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} |
map[string, map[string, string]] |
No | - | - |
description |
A description of the announcement subscription. Avoid entering confidential information. | string |
No | - | - |
displayName |
A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No | - | - |
filterGroups |
A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes. | map[string, object] |
No | - | - |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
map[string, string] |
No | - | - |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the announcement subscription. | string |
No | - | - |
lifecycleDetails |
A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state. | string |
No | - | - |
lifecycleState |
The current lifecycle state of the announcement subscription. | string |
No | - | - |
onsTopicId |
The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. | string |
No | - | - |
preferredLanguage |
(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR. | string |
No | - | - |
preferredTimeZone |
The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The date and time that the announcement subscription was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
timeUpdated |
The date and time that the announcement subscription was updated, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) timestamp format. | string |
No | - | - |
Status.filterGroups{}¶
Back to AnnouncementSubscription status
AnnouncementSubscriptionFilterGroups defines nested fields for AnnouncementSubscription.FilterGroups.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
filters |
A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. | list[object] |
Yes | - | - |
Status.filterGroups{}.filters[]¶
Back to AnnouncementSubscription status
AnnouncementSubscriptionFilterGroupsFilter defines nested fields for AnnouncementSubscription.FilterGroups.Filter.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
type |
The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually. | string |
Yes | - | - |
value |
The value of the filter. | string |
Yes | - | - |
Status.status¶
Back to AnnouncementSubscription 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 AnnouncementSubscription 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 AnnouncementSubscription 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 AnnouncementSubscription status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |