groups
Creates, updates, deletes, gets or lists a groups resource.
Overview​
| Name | groups |
| Type | Resource |
| Id | oci.streaming.groups |
Fields​
The following fields are returned by SELECT queries:
- get
Group State
| Name | Datatype | Description |
|---|---|---|
groupName | string | The name of the consumer group. |
reservations | array | An array of the partition reservations of a group. |
streamId | string | The streamId for which the group exists. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | streamId, groupName, region | opc-request-id | Returns the current state of a consumer group.<br /> |
update | update | streamId, groupName, region | opc-request-id | Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.<br /> |
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 |
|---|---|---|
groupName | string | The name of the consumer group. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
streamId | string | The OCID of the stream. |
opc-request-id | string | The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
SELECT examples​
- get
Returns the current state of a consumer group.<br />
SELECT
groupName,
reservations,
streamId
FROM oci.streaming.groups
WHERE streamId = '{{ streamId }}' -- required
AND groupName = '{{ groupName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;
UPDATE examples​
- update
Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.<br />
UPDATE oci.streaming.groups
SET
time = '{{ time }}',
type = '{{ type }}'
WHERE
streamId = '{{ streamId }}' --required
AND groupName = '{{ groupName }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}';