consulrs 0.1.0

An asynchronous Rust client library for the Hashicorp Consul 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
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

use super::{
    common::{ServiceCheck, SessionEntry},
    responses::CreateSessionResponse,
};
use crate::api::Features;
use consulrs_derive::QueryEndpoint;
use derive_builder::Builder;
use rustify_derive::Endpoint;
use serde::Serialize;
use std::fmt::Debug;

/// ## Create Session
/// This endpoint initializes a new session.
///
/// * Path: session/create
/// * Method: PUT
/// * Response: [CreateSessionResponse]
/// * Reference: https://www.consul.io/api-docs/session#create-session
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(
    path = "session/create",
    method = "PUT",
    response = "CreateSessionResponse",
    builder = "true"
)]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct CreateSessionRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    pub behavior: Option<String>,
    pub create_index: Option<u64>,
    #[serde(rename = "ID")]
    pub id: Option<String>,
    pub lock_delay: Option<String>,
    pub name: Option<String>,
    pub namespace: Option<String>,
    pub node: Option<String>,
    pub node_checks: Option<Vec<String>>,
    pub service_checks: Option<Vec<ServiceCheck>>,
    #[serde(rename = "TTL")]
    pub ttl: Option<String>,
}

/// ## Delete Session
/// This endpoint destroys the session with the given name.
///
/// * Path: session/destroy/{self.uuid}
/// * Method: PUT
/// * Response: N/A
/// * Reference: https://www.consul.io/api-docs/session#delete-session
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(path = "session/destroy/{self.uuid}", method = "PUT", builder = "true")]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct DeleteSessionRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub uuid: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
}

/// ## Read Session
/// This endpoint returns the requested session information.
///
/// * Path: session/info/{self.uuid}
/// * Method: GET
/// * Response: [Vec<SessionEntry>]
/// * Reference: https://www.consul.io/api-docs/session#read-session
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(
    path = "session/info/{self.uuid}",
    response = "Vec<SessionEntry>",
    builder = "true"
)]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct ReadSessionRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub uuid: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
}

/// ## List Sessions for Node
/// This endpoint returns the active sessions for a given node.
///
/// * Path: session/node/{self.node}
/// * Method: GET
/// * Response: [Vec<SessionEntry>]
/// * Reference: https://www.consul.io/api-docs/session#list-sessions-for-node
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(
    path = "session/node/{self.node}",
    response = "Vec<SessionEntry>",
    builder = "true"
)]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct ListNodeSessionsRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub node: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
}

/// ## List Sessions
/// This endpoint returns the list of active sessions.
///
/// * Path: session/list
/// * Method: GET
/// * Response: [Vec<SessionEntry>]
/// * Reference: https://www.consul.io/api-docs/session#list-sessions
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(
    path = "session/list",
    response = "Vec<SessionEntry>",
    builder = "true"
)]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct ListSessionsRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
}

/// ## Renew Session
/// This endpoint renews the given session.
///
/// * Path: session/renew/{self.uuid}
/// * Method: PUT
/// * Response: [Vec<SessionEntry>]
/// * Reference: https://www.consul.io/api-docs/session#renew-session
#[derive(Builder, Clone, Debug, Default, Endpoint, QueryEndpoint, Serialize)]
#[endpoint(
    path = "session/renew/{self.uuid}",
    method = "PUT",
    response = "Vec<SessionEntry>",
    builder = "true"
)]
#[serde(rename_all = "PascalCase")]
#[builder(setter(into, strip_option), default)]
pub struct RenewSessionRequest {
    #[endpoint(skip)]
    #[serde(skip)]
    pub features: Option<Features>,
    #[endpoint(skip)]
    pub uuid: String,
    #[endpoint(query)]
    pub dc: Option<String>,
    #[endpoint(query)]
    pub ns: Option<String>,
}