provider_shared_resources

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

Overview

Name	provider_shared_resources
Type	Resource
Id	confluent.stream_sharing.provider_shared_resources

Fields

The following fields are returned by SELECT queries:

get_cdx_v1_provider_shared_resource

Provider 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)
cluster_name	string	The cluster display name of the shared resource. Deprecated (example: Published Trades)
display_name	string	Shared resource display name (example: Stock Trades)
environment_name	string	The environment name of the shared resource. Deprecated (example: Public Env)
organization_name		Organization to which the shared resource belongs. Deprecated (example: ABC Corp)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud_cluster	object	The cloud cluster to which this belongs.
crn	string (uri)	Deprecated please use resources attribute. (pattern: ^crn://.+$, example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic)
description	string	Description of shared resource (example: This topic provides realtime data for the orders placed through the website)
kind	string	Kind defines the object this REST resource represents. (ProviderSharedResource)
logo_url	string (uri)	Resource logo url (example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization_contact	string (email)	Email of contact person from the organization (example: jane.doe@example.com)
organization_description	string	Shared resource's organization description (example: ABC Corp is the biggest online retailer)
resources	array	List of resource crns that are shared together
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_provider_shared_resources

Provider 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)
cluster_name	string	The cluster display name of the shared resource. Deprecated (example: Published Trades)
display_name	string	Shared resource display name (example: Stock Trades)
environment_name	string	The environment name of the shared resource. Deprecated (example: Public Env)
organization_name		Organization to which the shared resource belongs. Deprecated (example: ABC Corp)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud_cluster	object	The cloud cluster to which this belongs.
crn	string (uri)	Deprecated please use resources attribute. (pattern: ^crn://.+$, example: crn://confluent.cloud/environment=env-123/cloud-cluster=lkc-1111aaa/kafka=lkc-111aaa/topic=my.topic)
description	string	Description of shared resource (example: This topic provides realtime data for the orders placed through the website)
kind	string	Kind defines the object this REST resource represents. (ProviderSharedResource)
logo_url	string (uri)	Resource logo url (example: https://confluent.cloud/api/cdx/v1/provider-shared-resources/sr-123/images/logo)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization_contact	string (email)	Email of contact person from the organization (example: jane.doe@example.com)
organization_description	string	Shared resource's organization description (example: ABC Corp is the biggest online retailer)
resources	array	List of resource crns that are shared together
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_provider_shared_resource	select	id		Make a request to read a provider shared resource.
list_cdx_v1_provider_shared_resources	select		stream_share, crn, include_deleted, page_size, page_token	Retrieve a sorted, filtered, paginated list of all provider shared resources.
update_cdx_v1_provider_shared_resource	update	id		Make a request to update a provider shared resource.
delete_image_cdx_v1_provider_shared_resource	delete	id, file_name		Deletes the image file for the shared resource
upload_image_cdx_v1_provider_shared_resource	exec	id, file_name		Upload the image file for the shared resource
view_image_cdx_v1_provider_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 provider shared resource.
crn	string	Filter the results by exact match for crn. (example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic)
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_provider_shared_resource

Make a request to read a provider shared resource.

SELECT
id,
cluster_name,
display_name,
environment_name,
organization_name,
api_version,
cloud_cluster,
crn,
description,
kind,
logo_url,
metadata,
organization_contact,
organization_description,
resources,
schemas,
tags
FROM confluent.stream_sharing.provider_shared_resources
WHERE id = '{{ id }}' -- required
;

list_cdx_v1_provider_shared_resources

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

SELECT
id,
cluster_name,
display_name,
environment_name,
organization_name,
api_version,
cloud_cluster,
crn,
description,
kind,
logo_url,
metadata,
organization_contact,
organization_description,
resources,
schemas,
tags
FROM confluent.stream_sharing.provider_shared_resources
WHERE stream_share = '{{ stream_share }}'
AND crn = '{{ crn }}'
AND include_deleted = '{{ include_deleted }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

UPDATE examples

update_cdx_v1_provider_shared_resource

Make a request to update a provider shared resource.

UPDATE confluent.stream_sharing.provider_shared_resources
SET 
crn = '{{ crn }}',
resources = '{{ resources }}',
display_name = '{{ display_name }}',
organization_description = '{{ organization_description }}',
organization_contact = '{{ organization_contact }}',
cloud_cluster = '{{ cloud_cluster }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
cluster_name,
display_name,
environment_name,
organization_name,
api_version,
cloud_cluster,
crn,
description,
kind,
logo_url,
metadata,
organization_contact,
organization_description,
resources,
schemas,
tags;

DELETE examples

delete_image_cdx_v1_provider_shared_resource

Deletes the image file for the shared resource

DELETE FROM confluent.stream_sharing.provider_shared_resources
WHERE id = '{{ id }}' --required
AND file_name = '{{ file_name }}' --required
;

Lifecycle Methods

upload_image_cdx_v1_provider_shared_resource

Upload the image file for the shared resource

EXEC confluent.stream_sharing.provider_shared_resources.upload_image_cdx_v1_provider_shared_resource 
@id='{{ id }}' --required, 
@file_name='{{ file_name }}' --required
;

view_image_cdx_v1_provider_shared_resource

Returns the image file for the shared resource

EXEC confluent.stream_sharing.provider_shared_resources.view_image_cdx_v1_provider_shared_resource 
@id='{{ id }}' --required, 
@file_name='{{ file_name }}' --required
;