consumer_shares

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

Overview

Name	consumer_shares
Type	Resource
Id	confluent.stream_sharing.consumer_shares

Fields

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").
api_version	string	APIVersion defines the schema version of this representation of a resource.
consumer_organization_name	string	Consumer organization name. Deprecated
consumer_user	object	The consumer user/invitee
consumer_user_name	string	Name of the consumer. Deprecated
invite_expires_at	string	The date and time at which the invitation will expire. Only for invited shares
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
provider_organization_name	string	Provider organization name
provider_user_name	string	Name or email of the provider user
status	object	The status of the Consumer Share

Methods

Name	Accessible by	Required Params	Description
get_cdx_v1consumer_share	SELECT	id	Make a request to read a consumer share.
list_cdx_v1consumer_shares	SELECT		Retrieve a sorted, filtered, paginated list of all consumer shares.
delete_cdx_v1consumer_share	DELETE	id	Make a request to delete a consumer share.

SELECT examples

Retrieve a sorted, filtered, paginated list of all consumer shares.

SELECT
id,
api_version,
consumer_organization_name,
consumer_user,
consumer_user_name,
invite_expires_at,
kind,
metadata,
provider_organization_name,
provider_user_name,
status
FROM confluent.stream_sharing.consumer_shares
;

DELETE example

Deletes the specified consumer_shares resource.

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