consumer_shared_resources

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

Overview

Name	consumer_shared_resources
Type	Resource
Id	confluent.stream_sharing.consumer_shared_resources

Fields

The following fields are returned by SELECT queries:

get_cdx_v1_consumer_shared_resource

Consumer Shared Resource.

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	Consumer resource display name (example: Stock Trades)
organization_name	string	Shared resource's organization name (example: ABC Corp)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud	string	The cloud service provider of the provider shared cluster. (example: AWS)
description	string	Description of consumer resource (example: This topic provides realtime data for the orders placed through the website)
kind	string	Kind defines the object this REST resource represents. (ConsumerSharedResource)
logo_url	string (uri)	Resource logo url (example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
network_connection_types	array	The network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty
organization_contact	string (email)	Email of the shared resource's organization contact (example: jane.doe@example.com)
organization_description	string	Shared resource's organization description (example: ABC Corp is the biggest online retailer)
schemas	array	List of schemas in JSON format. This field is work in progress and subject to changes.
tags	array	list of tags

list_cdx_v1_consumer_shared_resources

Consumer Shared Resource.

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	Consumer resource display name (example: Stock Trades)
organization_name	string	Shared resource's organization name (example: ABC Corp)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud	string	The cloud service provider of the provider shared cluster. (example: AWS)
description	string	Description of consumer resource (example: This topic provides realtime data for the orders placed through the website)
kind	string	Kind defines the object this REST resource represents. (ConsumerSharedResource)
logo_url	string (uri)	Resource logo url (example: https://confluent.cloud/api/cdx/v1/consumer-shared-resources/sr-123/images/logo)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
network_connection_types	array	The network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty
organization_contact	string (email)	Email of the shared resource's organization contact (example: jane.doe@example.com)
organization_description	string	Shared resource's organization description (example: ABC Corp is the biggest online retailer)
schemas	array	List of schemas in JSON format. This field is work in progress and subject to changes.
tags	array	list of tags

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cdx_v1_consumer_shared_resource	select	id		Make a request to read a consumer shared resource.
list_cdx_v1_consumer_shared_resources	select		stream_share, include_deleted, page_size, page_token	Retrieve a sorted, filtered, paginated list of all consumer shared resources.
image_cdx_v1_consumer_shared_resource	exec	id, file_name		Returns the image file for the shared resource

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
file_name	string	The File Name
id	string	The unique identifier for the consumer shared resource.
include_deleted	boolean	Include deactivated shared resources
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
stream_share	string	Filter the results by exact match for stream_share. (example: ss-1234)

SELECT examples

get_cdx_v1_consumer_shared_resource

Make a request to read a consumer shared resource.

SELECT
id,
display_name,
organization_name,
api_version,
cloud,
description,
kind,
logo_url,
metadata,
network_connection_types,
organization_contact,
organization_description,
schemas,
tags
FROM confluent.stream_sharing.consumer_shared_resources
WHERE id = '{{ id }}' -- required
;

list_cdx_v1_consumer_shared_resources

Retrieve a sorted, filtered, paginated list of all consumer shared resources.

SELECT
id,
display_name,
organization_name,
api_version,
cloud,
description,
kind,
logo_url,
metadata,
network_connection_types,
organization_contact,
organization_description,
schemas,
tags
FROM confluent.stream_sharing.consumer_shared_resources
WHERE stream_share = '{{ stream_share }}'
AND include_deleted = '{{ include_deleted }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

Lifecycle Methods

image_cdx_v1_consumer_shared_resource

Returns the image file for the shared resource

EXEC confluent.stream_sharing.consumer_shared_resources.image_cdx_v1_consumer_shared_resource 
@id='{{ id }}' --required, 
@file_name='{{ file_name }}' --required
;