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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
//! Node API: Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work.
use bollard_stubs::models::{Node, NodeSpec};
use bytes::Bytes;
use http_body_util::Full;
use crate::{docker::BodyType, errors::Error, Docker};
use http::{request::Builder, Method};
impl Docker {
/// ---
///
/// # List Nodes
///
/// # Arguments
///
/// - Optional [List Nodes Options](crate::query_parameters::ListNodesOptions) struct.
///
/// # Returns
///
/// - A vector of [Node](Node) struct, wrapped in a
/// Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
/// use bollard::query_parameters::ListNodesOptionsBuilder;
///
/// use std::collections::HashMap;
///
/// let mut filters = HashMap::new();
/// filters.insert("node.label", vec!["my-node-label"]);
///
/// let options = ListNodesOptionsBuilder::default()
/// .filters(&filters)
/// .build();
///
/// docker.list_nodes(Some(options));
/// ```
pub async fn list_nodes(
&self,
options: Option<crate::query_parameters::ListNodesOptions>,
) -> Result<Vec<Node>, Error> {
let url = "/nodes";
let req = self.build_request(
url,
Builder::new().method(Method::GET),
options,
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_value(req).await
}
/// ---
///
/// # Inspect a Node
///
/// # Arguments
///
/// - Node id or name as a string slice.
///
/// # Returns
///
/// - A [Models](Node) struct, wrapped in a Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// docker.inspect_node("my_node_name");
/// ```
pub async fn inspect_node(&self, node_name: &str) -> Result<Node, Error> {
let url = format!("/nodes/{node_name}");
let req = self.build_request(
&url,
Builder::new().method(Method::GET),
None::<String>,
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_value(req).await
}
/// ---
///
/// # Delete Node
///
/// Delete a node.
///
/// # Arguments
///
/// - Node id or name as a string slice.
/// - Optional [Delete Node Options](crate::query_parameters::DeleteNodeOptions) struct.
///
/// # Returns
///
/// - unit type `()`, wrapped in a Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
/// use bollard::query_parameters::DeleteNodeOptionsBuilder;
///
/// let options = DeleteNodeOptionsBuilder::default()
/// .force(true)
/// .build();
///
/// docker.delete_node("my-node", Some(options));
/// ```
pub async fn delete_node(
&self,
node_name: &str,
options: Option<crate::query_parameters::DeleteNodeOptions>,
) -> Result<(), Error> {
let url = format!("/nodes/{node_name}");
let req = self.build_request(
&url,
Builder::new().method(Method::DELETE),
options,
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_unit(req).await
}
/// ---
///
/// # Update Node
///
/// Update a node.
///
/// # Arguments
///
/// - Node id as string slice.
/// - [Update Node Options](crate::query_parameters::UpdateNodeOptions) struct.
///
/// # Returns
///
/// - unit type `()`, wrapped in a Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
/// use bollard::query_parameters::UpdateNodeOptionsBuilder;
/// use bollard::models::{NodeSpec, NodeSpecAvailabilityEnum, NodeSpecRoleEnum};
///
/// let spec = NodeSpec {
/// availability: Some(NodeSpecAvailabilityEnum::ACTIVE),
/// name: Some("my-new-node-name".to_string()),
/// role: Some(NodeSpecRoleEnum::MANAGER),
/// ..Default::default()
/// };
///
/// let options = UpdateNodeOptionsBuilder::default()
/// .version(2)
/// .build();
///
/// docker.update_node("my-node-id", spec, options);
/// ```
pub async fn update_node(
&self,
node_id: &str,
spec: NodeSpec,
options: crate::query_parameters::UpdateNodeOptions,
) -> Result<(), Error> {
let url = format!("/nodes/{node_id}/update");
let req = self.build_request(
&url,
Builder::new().method(Method::POST),
Some(options),
Docker::serialize_payload(Some(spec)),
);
self.process_into_unit(req).await
}
}