Skip to main content

canton_api_client/models/
event_format.rs

1/*
2 * JSON Ledger API HTTP endpoints
3 *
4 * This specification version fixes the API inconsistencies where certain fields marked as required in the spec are in fact optional. If you use code generation tool based on this file, you might need to adjust the existing application code to handle those fields as optional. If you do not want to change your client code, continue using the OpenAPI specification from the previous Canton 3.4 patch release. MINIMUM_CANTON_VERSION=3.4.12
5 *
6 * The version of the OpenAPI document: 3.4.12-SNAPSHOT
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// EventFormat : A format for events which defines both which events should be included and what data should be computed and included for them.  Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct EventFormat {
17    #[serde(rename = "filtersByParty", skip_serializing_if = "Option::is_none")]
18    pub filters_by_party: Option<std::collections::HashMap<String, models::Filters>>,
19    #[serde(rename = "filtersForAnyParty", skip_serializing_if = "Option::is_none")]
20    pub filters_for_any_party: Option<Box<models::Filters>>,
21    /// If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.  Optional
22    #[serde(rename = "verbose", skip_serializing_if = "Option::is_none")]
23    pub verbose: Option<bool>,
24}
25
26impl EventFormat {
27    /// A format for events which defines both which events should be included and what data should be computed and included for them.  Note that some of the filtering behavior depends on the `TransactionShape`, which is expected to be specified alongside usages of `EventFormat`.
28    pub fn new() -> EventFormat {
29        EventFormat {
30            filters_by_party: None,
31            filters_for_any_party: None,
32            verbose: None,
33        }
34    }
35}
36