notification_types

Creates, updates, deletes, gets or lists a notification_types resource.

Overview

Name	notification_types
Type	Resource
Id	confluent.notifications.notification_types

Fields

The following fields are returned by SELECT queries:

get_notifications_v1_notification_type

Notification Type.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
display_name	string	Human readable display name of the notification type (example: Cluster Shrink)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
category	string	Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. (example: BILLING_LICENSING)
description	string	Human readable description of the notification type (example: Cluster shrink operation is completed)
is_included_in_plan	boolean	Whether this notification is available to subscribe or not as per the user's current billing plan.
kind	string	Kind defines the object this REST resource represents. (NotificationType)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
severity	string	Severity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification. (example: INFO)
subscription_priority	string	Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. (example: REQUIRED)

list_notifications_v1_notification_types

List of Notification Type.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
display_name	string	Human readable display name of the notification type (example: Cluster Shrink)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
category	string	Represents the group with which the notification is associated. Notifications are grouped under certain categories for better organization. - BILLING_LICENSING: All billing, payments or licensing related notifications are grouped here. - SECURITY: All Confluent Cloud and Platform security related notifications are grouped here. - SERVICE: All Confluent services (eg. Kafka, Schema Registry, Connect etc.) related notifications are grouped here. - ACCOUNT: All Confluent account related notifications are grouped here. For example: Billing, payment or license related notifications are grouped in BILLING_LICENSING category. (example: BILLING_LICENSING)
description	string	Human readable description of the notification type (example: Cluster shrink operation is completed)
is_included_in_plan	boolean	Whether this notification is available to subscribe or not as per the user's current billing plan.
kind	string	Kind defines the object this REST resource represents. (NotificationType)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
severity	string	Severity indicates the impact of this notification. - CRITICAL: a high impact notification which needs immediate attention. - WARN: a warning notification which can be addressed now or later. - INFO: an informational notification. (example: INFO)
subscription_priority	string	Indicates whether the notification is auto-subscribed and if the user can opt-out. - REQUIRED: the user is auto-subscribed to this notification and can't opt-out. - RECOMMENDED: the user is auto-subscribed to this notification and can opt-out. - OPTIONAL: the user is not auto-subscribed to this notification but can explicitly subscribe to it. (example: REQUIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notifications_v1_notification_type	select	id		Make a request to read a notification type.
list_notifications_v1_notification_types	select		resource_type, page_size, page_token	Make a request to list_by_resource_type a notification type.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The unique identifier for the notification type.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
resource_type	string	Confluent Cloud resource type

SELECT examples

get_notifications_v1_notification_type

Make a request to read a notification type.

SELECT
id,
display_name,
api_version,
category,
description,
is_included_in_plan,
kind,
metadata,
severity,
subscription_priority
FROM confluent.notifications.notification_types
WHERE id = '{{ id }}' -- required
;

list_notifications_v1_notification_types

Make a request to list_by_resource_type a notification type.

SELECT
id,
display_name,
api_version,
category,
description,
is_included_in_plan,
kind,
metadata,
severity,
subscription_priority
FROM confluent.notifications.notification_types
WHERE resource_type = '{{ resource_type }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;