OptionalbodyOptionalheadersOptionals2-format?: S2FormatDefines the interpretation of record data (header name, header value, and body) with the JSON content type.
Use raw (default) for efficient transmission and storage of Unicode data — storage will be in UTF-8.
Use base64 for safe transmission with efficient storage of binary data.
Stream name.
OptionalqueryOptionalbytes?: numberMetered bytes limit. Non-streaming reads are capped by the default limit of 1 MiB.
Optionalclamp?: booleanStart reading from the tail if the requested position is beyond it.
Otherwise, a 416 Range Not Satisfiable response is returned.
Optionalcount?: numberRecord count limit. Non-streaming reads are capped by the default limit of 1000 records.
Optionalseq_num?: U64Start from a sequence number.
Optionaltail_offset?: numberStart from number of records before the next sequence number.
Optionaltimestamp?: U64Start from a timestamp.
Optionaluntil?: U64Exclusive timestamp to read until.
Optionalwait?: numberDuration in seconds to wait for new records.
The default duration is 0 if there is a bound on count, bytes, or until, and otherwise infinite.
Non-streaming reads are always bounded on count and bytes, so you can achieve long poll semantics by specifying a non-zero duration up to 60 seconds.
In the context of an SSE or S2S streaming read, the duration will bound how much time can elapse between records throughout the lifetime of the session.
Generated API types re-exported for convenience.
These mirror the server REST resources and payloads.