resource_subscriptions

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

Overview

Name	resource_subscriptions
Type	Resource
Id	confluent.notifications.resource_subscriptions

Fields

The following fields are returned by SELECT queries:

get_notifications_v1_resource_subscription

Resource Subscription.

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)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
current_state	string	Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for REQUIRED notification type even when it is DISABLED. (example: ENABLED)
integrations	array	Integrations to which notifications are to be sent.
kind	string	Kind defines the object this REST resource represents. (ResourceSubscription)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
notification_type	object	The type of notification to subscribe to.
resource	string	Denotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
resource_type	string	Denotes the Confluent Cloud resource type. (example: CONNECTOR)

list_notifications_v1_resource_subscriptions_by_filter

List of ResourceSubscriptions

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)
api_version	string	APIVersion defines the schema version of this representation of a resource. (notifications/v1)
current_state	string	Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not receive any notification for the resource. Note that, you will still receive notifications for REQUIRED notification type even when it is DISABLED. (example: ENABLED)
integrations	array	Integrations to which notifications are to be sent.
kind	string	Kind defines the object this REST resource represents. (ResourceSubscription)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
notification_type	object	The type of notification to subscribe to.
resource	string	Denotes the Confluent Cloud resource definition. (example: environment=env-456xy/cloud-cluster=lkc-df123/connector=my_datagen_connector)
resource_type	string	Denotes the Confluent Cloud resource type. (example: CONNECTOR)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_notifications_v1_resource_subscription	select	id		Make a request to read a resource subscription.
list_notifications_v1_resource_subscriptions_by_filter	select	resource, resource_type	page_size, page_token	Make a request to list_by_filter a resource subscription.
create_notifications_v1_resource_subscription	insert	resource, resource_type, notification_type, integrations		Make a request to create a resource subscription.
update_notifications_v1_resource_subscription	update	id		Make a request to update a resource subscription.
delete_notifications_v1_resource_subscription	delete	id		Make a request to delete a resource subscription.

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 resource subscription.
resource	string	Confluent Cloud resource definition
resource_type	string	Confluent Cloud resource type
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_notifications_v1_resource_subscription

Make a request to read a resource subscription.

SELECT
id,
api_version,
current_state,
integrations,
kind,
metadata,
notification_type,
resource,
resource_type
FROM confluent.notifications.resource_subscriptions
WHERE id = '{{ id }}' -- required
;

list_notifications_v1_resource_subscriptions_by_filter

Make a request to list_by_filter a resource subscription.

SELECT
id,
api_version,
current_state,
integrations,
kind,
metadata,
notification_type,
resource,
resource_type
FROM confluent.notifications.resource_subscriptions
WHERE resource = '{{ resource }}' -- required
AND resource_type = '{{ resource_type }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_notifications_v1_resource_subscription

Make a request to create a resource subscription.

INSERT INTO confluent.notifications.resource_subscriptions (
resource,
resource_type,
current_state,
notification_type,
integrations
)
SELECT 
'{{ resource }}' /* required */,
'{{ resource_type }}' /* required */,
'{{ current_state }}',
'{{ notification_type }}' /* required */,
'{{ integrations }}' /* required */
RETURNING
id,
api_version,
current_state,
integrations,
kind,
metadata,
notification_type,
resource,
resource_type
;

Manifest

# Description fields are for documentation purposes
- name: resource_subscriptions
props:
  - name: resource
    value: "{{ resource }}"
    description: |
      Denotes the Confluent Cloud resource definition.
  - name: resource_type
    value: "{{ resource_type }}"
    description: |
      Denotes the Confluent Cloud resource type.
  - name: current_state
    value: "{{ current_state }}"
    description: |
      Denotes the state of the resource preference. When the resource preference is ENABLED, the user will receive
      notifications for the Confluent Cloud resource. If the resource preference is DISABLED, the user will not
      receive any notification for the resource.
      Note that, you will still receive notifications for `REQUIRED` notification type even when it is DISABLED.
  - name: notification_type
    description: |
      The type of notification to subscribe to.
    value:
      id: "{{ id }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"
  - name: integrations
    description: |
      Integrations to which notifications are to be sent.
    value:
      - id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_notifications_v1_resource_subscription

Make a request to update a resource subscription.

UPDATE confluent.notifications.resource_subscriptions
SET 
resource = '{{ resource }}',
resource_type = '{{ resource_type }}',
current_state = '{{ current_state }}',
notification_type = '{{ notification_type }}',
integrations = '{{ integrations }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
api_version,
current_state,
integrations,
kind,
metadata,
notification_type,
resource,
resource_type;

DELETE examples

delete_notifications_v1_resource_subscription

Make a request to delete a resource subscription.

DELETE FROM confluent.notifications.resource_subscriptions
WHERE id = '{{ id }}' --required
;