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

The following fields are returned by SELECT queries:

get_cdx_v1_consumer_share

Consumer Share.

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)
consumer_organization_name	string	Consumer organization name. Deprecated (example: Nasdaq)
consumer_user_name	string	Name of the consumer. Deprecated (example: John Doe)
provider_organization_name	string	Provider organization name (example: Nasdaq)
provider_user_name	string	Name or email of the provider user (example: Jane Doe)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
consumer_user	object	The consumer user/invitee
invite_expires_at	string (date-time)	The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
kind	string	Kind defines the object this REST resource represents. (ConsumerShare)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
status	object	The status of the Consumer Share

list_cdx_v1_consumer_shares

Consumer Share.

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)
consumer_organization_name	string	Consumer organization name. Deprecated (example: Nasdaq)
consumer_user_name	string	Name of the consumer. Deprecated (example: John Doe)
provider_organization_name	string	Provider organization name (example: Nasdaq)
provider_user_name	string	Name or email of the provider user (example: Jane Doe)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
consumer_user	object	The consumer user/invitee
invite_expires_at	string (date-time)	The date and time at which the invitation will expire. Only for invited shares (example: 2006-01-02T15:04:05-07:00)
kind	string	Kind defines the object this REST resource represents. (ConsumerShare)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
status	object	The status of the Consumer Share

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cdx_v1_consumer_share	select	id		Make a request to read a consumer share.
list_cdx_v1_consumer_shares	select		shared_resource, include_deleted, page_size, page_token	Retrieve a sorted, filtered, paginated list of all consumer shares.
delete_cdx_v1_consumer_share	delete	id		Make a request to delete a consumer share.

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
id	string	The unique identifier for the consumer share.
include_deleted	boolean	Include deactivated shares
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
shared_resource	string	Filter the results by exact match for shared_resource. (example: sr-1234)

SELECT examples

get_cdx_v1_consumer_share

Make a request to read a consumer share.

SELECT
id,
consumer_organization_name,
consumer_user_name,
provider_organization_name,
provider_user_name,
api_version,
consumer_user,
invite_expires_at,
kind,
metadata,
status
FROM confluent.stream_sharing.consumer_shares
WHERE id = '{{ id }}' -- required
;

list_cdx_v1_consumer_shares

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

SELECT
id,
consumer_organization_name,
consumer_user_name,
provider_organization_name,
provider_user_name,
api_version,
consumer_user,
invite_expires_at,
kind,
metadata,
status
FROM confluent.stream_sharing.consumer_shares
WHERE shared_resource = '{{ shared_resource }}'
AND include_deleted = '{{ include_deleted }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

DELETE examples

delete_cdx_v1_consumer_share

Make a request to delete a consumer share.

DELETE FROM confluent.stream_sharing.consumer_shares
WHERE id = '{{ id }}' --required
;