Skip to main content

provider_shared_resources

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

Overview

Nameprovider_shared_resources
TypeResource
Idconfluent.stream_sharing.provider_shared_resources

Fields

NameDatatypeDescription
idstringID 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").
descriptionstringDescription of shared resource
_cloud_cluster``
api_versionstringAPIVersion defines the schema version of this representation of a resource.
cloud_clusterobjectThe cloud cluster to which this belongs.
cluster_namestringThe cluster display name of the shared resource. Deprecated
crnstringDeprecated please use resources attribute.
display_namestringShared resource display name
environment_namestringThe environment name of the shared resource. Deprecated
kindstringKind defines the object this REST resource represents.
logo_urlstringResource logo url
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
organization_contactstringEmail of contact person from the organization
organization_descriptionstringShared resource's organization description
organization_name``Organization to which the shared resource belongs. Deprecated
resourcesarrayList of resource crns that are shared together
schemasarrayList of schemas in JSON format. This field is work in progress and subject to changes.
tagsarraylist of tags

Methods

NameAccessible byRequired ParamsDescription
get_cdx_v1provider_shared_resourceSELECTidGeneral Availability Make a request to read a provider shared resource.
list_cdx_v1provider_shared_resourcesSELECTGeneral Availability Retrieve a sorted, filtered, paginated list of all provider shared resources.
delete_image_cdx_v1provider_shared_resourceDELETEfile_name, idGeneral Availability Deletes the image file for the shared resource
update_cdx_v1provider_shared_resourceUPDATEidGeneral Availability Make a request to update a provider shared resource.
upload_image_cdx_v1provider_shared_resourceEXECfile_name, idGeneral Availability Upload the image file for the shared resource
view_image_cdx_v1provider_shared_resourceEXECfile_name, idGeneral Availability Returns the image file for the shared resource

SELECT examples

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

SELECT
id,
description,
_cloud_cluster,
api_version,
cloud_cluster,
cluster_name,
crn,
display_name,
environment_name,
kind,
logo_url,
metadata,
organization_contact,
organization_description,
organization_name,
resources,
schemas,
tags
FROM confluent.stream_sharing.provider_shared_resources
;

UPDATE example

Updates a provider_shared_resources resource.

/*+ update */
UPDATE confluent.stream_sharing.provider_shared_resources
SET
resources = '{{ resources }}',
display_name = '{{ display_name }}',
organization_description = '{{ organization_description }}',
organization_contact = '{{ organization_contact }}'
WHERE
id = '{{ id }}';

DELETE example

Deletes the specified provider_shared_resources resource.

/*+ delete */
DELETE FROM confluent.stream_sharing.provider_shared_resources
WHERE file_name = '{{ file_name }}'
AND id = '{{ id }}';