{ "opencollection": "1.0.0", "info": { "name": "Streaming Stream API", "version": "20180418" }, "items": [ { "info": { "name": "stream", "type": "folder" }, "items": [ { "info": { "name": "Commits processed offsets to consumer group state.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/commit", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" }, { "name": "cursor", "value": "", "type": "query", "description": "The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n" } ] }, "docs": "Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.\nThis commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.\n" }, { "info": { "name": "Creates a cursor for the specified stream. A cursor is used to consume a stream.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/cursors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there.\nYou can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message\ninside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based\non the most recent message allows consumption of only messages that are added to the stream after y" }, { "info": { "name": "Creates a group-cursor for the specified stream. A cursor is used to consume a stream.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/groupCursors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a group-cursor.\n" }, { "info": { "name": "Returns the current state of a consumer group.", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/groups/:groupName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" }, { "name": "groupName", "value": "", "type": "path", "description": "The name of the consumer group." } ] }, "docs": "Returns the current state of a consumer group.\n" }, { "info": { "name": "Forcefully changes the committed location of a group on a stream.", "type": "http" }, "http": { "method": "PUT", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/groups/:groupName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" }, { "name": "groupName", "value": "", "type": "path", "description": "The name of the consumer group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.\n" }, { "info": { "name": "Extends the reservation timeout on partitions reserved by the provided cursor.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/heartbeat", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" }, { "name": "cursor", "value": "", "type": "query", "description": "The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n" } ] }, "docs": "Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.\n" }, { "info": { "name": "Gets messages from a stream.", "type": "http" }, "http": { "method": "GET", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/messages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" }, { "name": "cursor", "value": "", "type": "query", "description": "The cursor used to consume the stream.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible.\nConsider your average message size to help avoid exceeding throughput on the stream.\n" } ] }, "docs": "Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible.\nTo get messages, you must first obtain a cursor using the [CreateCursor](#/en/streaming/20180418/Cursor/CreateCursor) operation.\nIn the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.\n" }, { "info": { "name": "Puts messages in a stream.", "type": "http" }, "http": { "method": "POST", "url": "https://streaming.{region}.oci.oraclecloud.com/20180418/streams/:streamId/messages", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "streamId", "value": "", "type": "path", "description": "The OCID of the stream.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less.\nThe service calculates the partition ID from the message key and stores messages that share a key on the same partition.\nIf a message does not contain a key or if the key is null, the service generates a message key for you.\nThe partition ID cannot be passed as a parameter.\n" } ] } ], "bundled": true }