dataplane-sdk 0.1.1

A Rust SDK for building data planes that interface with Dataspace Protocol Control Planes via the Data Plane Signaling API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//  Copyright (c) 2026 Metaform Systems, Inc
//
//  This program and the accompanying materials are made available under the
//  terms of the Apache License, Version 2.0 which is available at
//  https://www.apache.org/licenses/LICENSE-2.0
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Contributors:
//         Metaform Systems, Inc. - initial API and implementation
//

use std::collections::HashMap;

use bon::Builder;
use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::{data_address::DataAddress, data_flow::DataFlowState};

#[derive(Debug, Serialize, Deserialize, Clone, Builder)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowStartMessage {
    pub message_id: String,
    pub participant_id: String,
    pub counter_party_id: String,
    pub dataspace_context: String,
    pub process_id: String,
    pub agreement_id: String,
    pub dataset_id: String,
    pub profile: String,
    pub data_address: Option<DataAddress>,
    #[builder(default)]
    #[serde(default)]
    pub labels: Vec<String>,
    #[builder(default)]
    #[serde(default)]
    pub metadata: HashMap<String, Value>,
    #[builder(default)]
    #[serde(default)]
    pub claims: HashMap<String, Value>,
}

#[derive(Debug, Serialize, Deserialize, Clone, Builder)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowResumeMessage {
    pub data_address: Option<DataAddress>,
}

#[derive(Debug, Serialize, Deserialize, Clone, Builder)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowPrepareMessage {
    pub message_id: String,
    pub participant_id: String,
    pub counter_party_id: String,
    pub dataspace_context: String,
    pub process_id: String,
    pub agreement_id: String,
    pub dataset_id: String,
    pub profile: String,
    #[builder(default)]
    #[serde(default)]
    pub labels: Vec<String>,
    #[builder(default)]
    #[serde(default)]
    pub metadata: HashMap<String, Value>,
    #[builder(default)]
    #[serde(default)]
    pub claims: HashMap<String, Value>,
}

#[derive(Debug, Builder, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowStatusMessage {
    #[builder(default = new_message_id())]
    #[serde(default = "new_message_id")]
    pub message_id: String,
    pub data_flow_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub data_address: Option<DataAddress>,
    pub state: DataFlowState,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

fn new_message_id() -> String {
    uuid::Uuid::new_v4().to_string()
}

#[derive(Debug, Builder, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct DataFlowStartedNotificationMessage {
    pub data_address: Option<DataAddress>,
}

#[derive(Builder, Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowStatusResponseMessage {
    pub data_flow_id: String,
    pub state: DataFlowState,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct DataFlowSuspendMessage {
    pub reason: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, Clone, Builder)]
#[serde(rename_all = "camelCase")]
#[builder(on(String, into))]
pub struct DataFlowTerminateMessage {
    pub reason: Option<String>,
}