Skip to main content

consumer_shared_resources

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

Overview

Nameconsumer_shared_resources
TypeResource
Idconfluent.stream_sharing.consumer_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 consumer resource
api_versionstringAPIVersion defines the schema version of this representation of a resource.
cloudstringThe cloud service provider of the provider shared cluster.
display_namestringConsumer resource display name
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.
network_connection_typesarrayThe network connection types of the provider shared cluster. If the shared cluster is on public internet, then the list will be empty
organization_contactstringEmail of the shared resource's organization contact
organization_descriptionstringShared resource's organization description
organization_namestringShared resource's organization name
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_v1consumer_shared_resourceSELECTidGeneral Availability Make a request to read a consumer shared resource.
list_cdx_v1consumer_shared_resourcesSELECTGeneral Availability Retrieve a sorted, filtered, paginated list of all consumer shared resources.
image_cdx_v1consumer_shared_resourceEXECfile_name, idGeneral Availability Returns the image file for the shared resource
network_cdx_v1consumer_shared_resourceEXECidGeneral Availability Returns network information of the shared resource

SELECT examples

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

SELECT
id,
description,
api_version,
cloud,
display_name,
kind,
logo_url,
metadata,
network_connection_types,
organization_contact,
organization_description,
organization_name,
schemas,
tags
FROM confluent.stream_sharing.consumer_shared_resources
;