canton-api-client 3.6.0-0.1.0

Canton Ledger API rust client
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
# GetActiveContractsPageRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active_at_offset** | Option<**i64**> | The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned. If not defined, the current ledger end will be used and it will be populated in the response.  Optional | [optional]
**event_format** | [**models::EventFormat**](EventFormat.md) |  | 
**max_page_size** | Option<**i32**> | The result page will contain at most max_page_size entries of the respective active contract snapshot. The server might reject max_page_size breaching the server-specified limit. Optional, if not defined, the default will be determined by the server.  Optional | [optional]
**page_token** | Option<**String**> | To get the next page of the active contracts snapshot, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetActiveContractsPageResponse``. The page token only works if subsequent requests:  - are executed on the same participant, - use the same active_at_offset and event_format, - and the participant's store was not pruned to after the active_at_offset.  If not specified, the first page of the active contracts snapshot will be returned.  Optional: can be empty | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)