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

The following fields are returned by SELECT queries:

get_cdx_v1_provider_share

Provider 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 (example: Nasdaq)
consumer_user_name	string	Name of the consumer (example: John Doe)
provider_user_name	string	Name or email of the provider user. Deprecated (example: Jane Doe)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud_cluster	object	The cloud cluster to which this belongs.
consumer_restriction	object	Restrictions on the consumer that can redeem this token
delivery_method	string	Method by which the invite will be delivered (example: EMAIL)
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)
invited_at	string (date-time)	The date and time at which consumer was invited (example: 2006-01-02T15:04:05-07:00)
kind	string	Kind defines the object this REST resource represents. (ProviderShare)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
provider_user	object	The provider user/inviter
redeemed_at	string (date-time)	The date and time at which the invite was redeemed (example: 2006-01-02T15:04:05-07:00)
service_account	object	The service account associated with this object.
status	object	The status of the Provider Share

list_cdx_v1_provider_shares

Provider 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 (example: Nasdaq)
consumer_user_name	string	Name of the consumer (example: John Doe)
provider_user_name	string	Name or email of the provider user. Deprecated (example: Jane Doe)
api_version	string	APIVersion defines the schema version of this representation of a resource. (cdx/v1)
cloud_cluster	object	The cloud cluster to which this belongs.
consumer_restriction	object	Restrictions on the consumer that can redeem this token
delivery_method	string	Method by which the invite will be delivered (example: EMAIL)
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)
invited_at	string (date-time)	The date and time at which consumer was invited (example: 2006-01-02T15:04:05-07:00)
kind	string	Kind defines the object this REST resource represents. (ProviderShare)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
provider_user	object	The provider user/inviter
redeemed_at	string (date-time)	The date and time at which the invite was redeemed (example: 2006-01-02T15:04:05-07:00)
service_account	object	The service account associated with this object.
status	object	The status of the Provider Share

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cdx_v1_provider_share	select	id		Make a request to read a provider share.
list_cdx_v1_provider_shares	select		shared_resource, crn, include_deleted, page_size, page_token	Retrieve a sorted, filtered, paginated list of all provider shares.
create_cdx_v1_provider_share	insert	delivery_method, consumer_restriction, resources		Creates a share based on delivery method.
delete_cdx_v1_provider_share	delete	id		Make a request to delete a provider share.
resend_cdx_v1_provider_share	exec	id		Resend provider 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 provider share.
crn	string	Filter the results by exact match for crn. (example: crn://confluent.cloud/cloud-cluster=lkc-111aaa/kafka=lkc-111aaa/topic=my.topic)
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_provider_share

Make a request to read a provider share.

SELECT
id,
consumer_organization_name,
consumer_user_name,
provider_user_name,
api_version,
cloud_cluster,
consumer_restriction,
delivery_method,
invite_expires_at,
invited_at,
kind,
metadata,
provider_user,
redeemed_at,
service_account,
status
FROM confluent.stream_sharing.provider_shares
WHERE id = '{{ id }}' -- required
;

list_cdx_v1_provider_shares

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

SELECT
id,
consumer_organization_name,
consumer_user_name,
provider_user_name,
api_version,
cloud_cluster,
consumer_restriction,
delivery_method,
invite_expires_at,
invited_at,
kind,
metadata,
provider_user,
redeemed_at,
service_account,
status
FROM confluent.stream_sharing.provider_shares
WHERE shared_resource = '{{ shared_resource }}'
AND crn = '{{ crn }}'
AND include_deleted = '{{ include_deleted }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_cdx_v1_provider_share

Creates a share based on delivery method.

INSERT INTO confluent.stream_sharing.provider_shares (
delivery_method,
consumer_restriction,
resources
)
SELECT 
'{{ delivery_method }}' /* required */,
'{{ consumer_restriction }}' /* required */,
'{{ resources }}' /* required */
RETURNING
id,
consumer_organization_name,
consumer_user_name,
provider_user_name,
api_version,
cloud_cluster,
consumer_restriction,
delivery_method,
invite_expires_at,
invited_at,
kind,
metadata,
provider_user,
redeemed_at,
service_account,
status
;

Manifest

# Description fields are for documentation purposes
- name: provider_shares
props:
  - name: delivery_method
    value: "{{ delivery_method }}"
    description: |
      Method by which the invite will be delivered
  - name: consumer_restriction
    description: |
      Restrictions on the consumer that can redeem this token
    value:
      kind: "{{ kind }}"
      email: "{{ email }}"
  - name: resources
    value:
      - "{{ resources }}"
    description: |
      List of resource crns to be shared

DELETE examples

delete_cdx_v1_provider_share

Make a request to delete a provider share.

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

Lifecycle Methods

resend_cdx_v1_provider_share

Resend provider share

EXEC confluent.stream_sharing.provider_shares.resend_cdx_v1_provider_share 
@id='{{ id }}' --required
;