opt_ins
Creates, updates, deletes, gets or lists an opt_ins resource.
Overview
| Name | opt_ins |
| Type | Resource |
| Id | confluent.stream_sharing.opt_ins |
Fields
The following fields are returned by SELECT queries:
- get_cdx_v1_opt_in
Opt In.
| Name | Datatype | Description |
|---|---|---|
api_version | string | APIVersion defines the schema version of this representation of a resource. (cdx/v1) |
kind | string | Kind defines the object this REST resource represents. (OptIn) |
stream_share_enabled | boolean | Enable stream sharing for the organization |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_cdx_v1_opt_in | select | Returns the organization's stream sharing opt-in settings. | ||
update_cdx_v1_opt_in | update | Updates the organization's stream sharing opt-in settings. |
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 |
|---|
SELECT examples
- get_cdx_v1_opt_in
Returns the organization's stream sharing opt-in settings.
SELECT
api_version,
kind,
stream_share_enabled
FROM confluent.stream_sharing.opt_ins
;
UPDATE examples
- update_cdx_v1_opt_in
Updates the organization's stream sharing opt-in settings.
UPDATE confluent.stream_sharing.opt_ins
SET
stream_share_enabled = {{ stream_share_enabled }}
RETURNING
api_version,
kind,
stream_share_enabled;