Ksui gRPC/sui.rpc.v2/ListEventsRequest

ListEventsRequest

interface ListEventsRequest

Request message for LedgerService.ListEvents.

Properties

Link copied to clipboard
abstract val endCheckpoint: <Error class: unknown class>?

Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.

Link copied to clipboard
abstract val filter: EventFilter

Optional. DNF filter over indexed dimensions. If absent, all events in the range are returned.

Link copied to clipboard
abstract val options: QueryOptions

Optional cursor-bounded query options. If unspecified, reads in ascending order with the default item limit. The server enforces a maximum item limit and silently coerces larger values down to it. To paginate, pass the last received Watermark.cursor as options.after (ascending) or options.before (descending) on the next request.

Link copied to clipboard
val ListEventsRequest.presence: ListEventsRequestPresence

Returns the field-presence view for this ListEventsRequest instance.

Link copied to clipboard
abstract val readMask: FieldMask

Optional. Mask for specifying which parts of the Event should be returned.

Link copied to clipboard
abstract val startCheckpoint: <Error class: unknown class>?

Optional. Start of the checkpoint range to query (inclusive). Defaults to genesis.

Functions

Link copied to clipboard
Link copied to clipboard
fun ListEventsRequest.copy(body: <Error class: unknown class>.() -> Unit = {}): ListEventsRequest

Copies the original message, including unknown fields.