Skip to main content

provider_shares

Overview

Nameprovider_shares
TypeResource
Idconfluent.stream_sharing.provider_shares

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").
_cloud_cluster``
_service_account``
api_versionstringAPIVersion defines the schema version of this representation of a resource.
cloud_clusterobjectThe cloud cluster to which this belongs.
consumer_organization_namestringConsumer organization name
consumer_restriction``Restrictions on the consumer that can redeem this token
consumer_user_namestringName of the consumer
delivery_methodstringMethod by which the invite will be delivered
invite_expires_atstringThe date and time at which the invitation will expire. Only for invited shares
invited_atstringThe date and time at which consumer was invited
kindstringKind 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_userobjectThe provider user/inviter
provider_user_namestringName or email of the provider user. Deprecated
redeemed_atstringThe date and time at which the invite was redeemed
service_accountobjectThe service account associated with this object.
statusobjectThe status of the Provider Share

Methods

NameAccessible byRequired ParamsDescription
get_cdx_v1provider_shareSELECTidGeneral Availability

Make a request to read a provider share.
list_cdx_v1provider_sharesSELECTGeneral Availability

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

Creates a share based on delivery method.
delete_cdx_v1provider_shareDELETEidGeneral Availability

Make a request to delete a provider share.
resend_cdx_v1provider_shareEXECidGeneral Availability

Resend provider share