provider_shares

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

Overview

Name	provider_shares
Type	Resource
Id	confluent.stream_sharing.provider_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").
_cloud_cluster	``
_service_account	``
api_version	string	APIVersion defines the schema version of this representation of a resource.
cloud_cluster	object	The cloud cluster to which this belongs.
consumer_organization_name	string	Consumer organization name
consumer_restriction	``	Restrictions on the consumer that can redeem this token
consumer_user_name	string	Name of the consumer
delivery_method	string	Method by which the invite will be delivered
invite_expires_at	string	The date and time at which the invitation will expire. Only for invited shares
invited_at	string	The date and time at which consumer was invited
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_user	object	The provider user/inviter
provider_user_name	string	Name or email of the provider user. Deprecated
redeemed_at	string	The date and time at which the invite was redeemed
service_account	object	The service account associated with this object.
status	object	The status of the Provider Share

Methods

Name	Accessible by	Required Params	Description
get_cdx_v1provider_share	SELECT	id	Make a request to read a provider share.
list_cdx_v1provider_shares	SELECT		Retrieve a sorted, filtered, paginated list of all provider shares.
create_cdx_v1provider_share	INSERT		Creates a share based on delivery method.
delete_cdx_v1provider_share	DELETE	id	Make a request to delete a provider share.
resend_cdx_v1provider_share	EXEC	id	Resend provider share

SELECT examples

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

SELECT
id,
_cloud_cluster,
_service_account,
api_version,
cloud_cluster,
consumer_organization_name,
consumer_restriction,
consumer_user_name,
delivery_method,
invite_expires_at,
invited_at,
kind,
metadata,
provider_user,
provider_user_name,
redeemed_at,
service_account,
status
FROM confluent.stream_sharing.provider_shares
;

INSERT example

Use the following StackQL query and manifest file to create a new provider_shares resource.

All Properties

/*+ create */
INSERT INTO confluent.stream_sharing.provider_shares (
data__delivery_method,
data__consumer_restriction,
data__resources
)
SELECT 
'{{ delivery_method }}',
'{{ consumer_restriction }}',
'{{ resources }}'
;

Manifest

- name: provider_shares
  props:
    - name: delivery_method
      value: string
    - name: consumer_restriction
      props:
        - name: kind
          value: string
        - name: email
          value: string
    - name: resources
      value: array

DELETE example

Deletes the specified provider_shares resource.

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