custom_code_loggings

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

Overview

Name	custom_code_loggings
Type	Resource
Id	confluent.ccl.custom_code_loggings

Fields

The following fields are returned by SELECT queries:

get_ccl_v1_custom_code_logging

Custom Code Logging.

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. (ccl/v1)
cloud	string	Cloud provider where the Custom Code Logging is sent. (example: AWS)
destination_settings	object	Destination Settings of the Custom Code Logging.
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (CustomCodeLogging)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
region	string	The Cloud provider region the Custom Code Logging is sent. (example: us-west-2)

list_ccl_v1_custom_code_loggings

Custom Code Logging.

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. (ccl/v1)
cloud	string	Cloud provider where the Custom Code Logging is sent. (example: AWS)
destination_settings	object	Destination Settings of the Custom Code Logging.
environment	object	The environment to which this belongs.
kind	string	Kind defines the object this REST resource represents. (CustomCodeLogging)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
region	string	The Cloud provider region the Custom Code Logging is sent. (example: us-west-2)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ccl_v1_custom_code_logging	select	environment, id		Make a request to read a custom code logging.
list_ccl_v1_custom_code_loggings	select	environment	page_size, page_token	Retrieve a sorted, filtered, paginated list of all custom code loggings.
create_ccl_v1_custom_code_logging	insert	cloud, region, destination_settings, environment		Make a request to create a custom code logging.
update_ccl_v1_custom_code_logging	update	environment, id, environment		Make a request to update a custom code logging.
delete_ccl_v1_custom_code_logging	delete	environment, id		Make a request to delete a custom code logging.

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
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the custom code logging.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_ccl_v1_custom_code_logging

Make a request to read a custom code logging.

SELECT
id,
api_version,
cloud,
destination_settings,
environment,
kind,
metadata,
region
FROM confluent.ccl.custom_code_loggings
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_ccl_v1_custom_code_loggings

Retrieve a sorted, filtered, paginated list of all custom code loggings.

SELECT
id,
api_version,
cloud,
destination_settings,
environment,
kind,
metadata,
region
FROM confluent.ccl.custom_code_loggings
WHERE environment = '{{ environment }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_ccl_v1_custom_code_logging

Make a request to create a custom code logging.

INSERT INTO confluent.ccl.custom_code_loggings (
cloud,
region,
destination_settings,
environment
)
SELECT 
'{{ cloud }}' /* required */,
'{{ region }}' /* required */,
'{{ destination_settings }}' /* required */,
'{{ environment }}' /* required */
RETURNING
id,
api_version,
cloud,
destination_settings,
environment,
kind,
metadata,
region
;

Manifest

# Description fields are for documentation purposes
- name: custom_code_loggings
props:
  - name: cloud
    value: "{{ cloud }}"
    description: |
      Cloud provider where the Custom Code Logging is sent.
  - name: region
    value: "{{ region }}"
    description: |
      The Cloud provider region the Custom Code Logging is sent.
  - name: destination_settings
    description: |
      Destination Settings of the Custom Code Logging.
    value:
      kind: "{{ kind }}"
      cluster_id: "{{ cluster_id }}"
      topic: "{{ topic }}"
      log_level: "{{ log_level }}"
  - name: environment
    description: |
      The environment to which this belongs.
    value:
      id: "{{ id }}"
      environment: "{{ environment }}"
      related: "{{ related }}"
      resource_name: "{{ resource_name }}"

UPDATE examples

update_ccl_v1_custom_code_logging

Make a request to update a custom code logging.

UPDATE confluent.ccl.custom_code_loggings
SET 
cloud = '{{ cloud }}',
region = '{{ region }}',
destination_settings = '{{ destination_settings }}',
environment = '{{ environment }}'
WHERE 
environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
AND environment = '{{ environment }}' --required
RETURNING
id,
api_version,
cloud,
destination_settings,
environment,
kind,
metadata,
region;

DELETE examples

delete_ccl_v1_custom_code_logging

Make a request to delete a custom code logging.

DELETE FROM confluent.ccl.custom_code_loggings
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;