monitor_client 1.13.3

Client for the monitor build and deployment system
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

use derive_empty_traits::EmptyTraits;
use resolver_api::derive::Request;
use serde::{Deserialize, Serialize};
use typeshare::typeshare;

use crate::entities::server_template::{
  ServerTemplate, ServerTemplateListItem, ServerTemplateQuery,
};

use super::MonitorReadRequest;

//

/// Get a specific server template by id or name. Response: [ServerTemplate].
#[typeshare]
#[derive(
  Serialize, Deserialize, Debug, Clone, Request, EmptyTraits,
)]
#[empty_traits(MonitorReadRequest)]
#[response(GetServerTemplateResponse)]
pub struct GetServerTemplate {
  /// Id or name
  #[serde(alias = "id", alias = "name")]
  pub server_template: String,
}

#[typeshare]
pub type GetServerTemplateResponse = ServerTemplate;

//

/// List server templates matching structured query. Response: [ListServerTemplatesResponse].
#[typeshare]
#[derive(
  Serialize, Deserialize, Debug, Clone, Default, Request, EmptyTraits,
)]
#[empty_traits(MonitorReadRequest)]
#[response(ListServerTemplatesResponse)]
pub struct ListServerTemplates {
  #[serde(default)]
  pub query: ServerTemplateQuery,
}

#[typeshare]
pub type ListServerTemplatesResponse = Vec<ServerTemplateListItem>;

//

/// List server templates matching structured query. Response: [ListFullServerTemplatesResponse].
#[typeshare]
#[derive(
  Serialize, Deserialize, Debug, Clone, Default, Request, EmptyTraits,
)]
#[empty_traits(MonitorReadRequest)]
#[response(ListFullServerTemplatesResponse)]
pub struct ListFullServerTemplates {
  #[serde(default)]
  pub query: ServerTemplateQuery,
}

#[typeshare]
pub type ListFullServerTemplatesResponse = Vec<ServerTemplate>;

//

/// Gets a summary of data relating to all server templates.
/// Response: [GetServerTemplatesSummaryResponse].
#[typeshare]
#[derive(
  Serialize, Deserialize, Debug, Clone, Request, EmptyTraits,
)]
#[empty_traits(MonitorReadRequest)]
#[response(GetServerTemplatesSummaryResponse)]
pub struct GetServerTemplatesSummary {}

/// Response for [GetServerTemplatesSummary].
#[typeshare]
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct GetServerTemplatesSummaryResponse {
  /// The total number of server templates.
  pub total: u32,
}