tes 0.10.0

A crate for working with the Task Execution Service (TES) specification
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

//! Requests to a service.

use std::collections::BTreeMap;

use crate::v1::types::task::Executor;
use crate::v1::types::task::Input;
use crate::v1::types::task::Output;
use crate::v1::types::task::Resources;
use crate::v1::types::task::State;

/// The default number of tasks to include in a page of `ListTasks` results.
pub const DEFAULT_PAGE_SIZE: u16 = 256;

/// The exclusive maximum number of tasks to include in a page of `ListTasks`
/// results.
pub const MAX_PAGE_SIZE: u16 = 2048;

/// A requested view of tasks.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "SCREAMING_SNAKE_CASE"))]
pub enum View {
    /// The `MINIMAL` view.
    #[default]
    Minimal,

    /// The `BASIC` view.
    Basic,

    /// The `FULL` view.
    Full,
}

/// The query parameters for `GetTask` endpoint.
#[derive(Copy, Clone, Debug, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct GetTaskParams {
    /// The view of the returned task.
    #[cfg_attr(feature = "serde", serde(default))]
    pub view: View,
}

/// The query parameters for `ListTasks` endpoint.
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ListTasksParams {
    /// The filter for task name (prefixed).
    ///
    /// If unspecified, no task name filtering is done.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub name_prefix: Option<String>,
    /// The filter for task state.
    ///
    /// If unspecified, no task state filtering is done.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub state: Option<State>,
    /// The filter for task tag keys.
    ///
    /// This is zipped with `tag_values`.
    ///
    /// If empty, no task tags filtering is done.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "tag_key", default, skip_serializing_if = "Option::is_none")
    )]
    pub tag_keys: Option<Vec<String>>,
    /// The filter for task tag values.
    ///
    /// This is zipped with `tag_keys`.
    ///
    /// If the value is empty, it matches all values.
    ///
    /// It is an error if more values are supplied than keys.
    #[cfg_attr(
        feature = "serde",
        serde(rename = "tag_value", default, skip_serializing_if = "Option::is_none")
    )]
    pub tag_values: Option<Vec<String>>,
    /// The number of tasks to return in one page.
    ///
    /// Must be less than 2048. Defaults to 256.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub page_size: Option<u16>,
    /// The page token to retrieve the next page of results.
    ///
    /// If unspecified, returns the first page of results.
    ///
    /// The value can be found in the `next_page_token`` field of the last
    /// returned result of `list_tasks`.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub page_token: Option<String>,
    /// The view of the returned task(s).
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub view: Option<View>,
}

/// Represents the request body of the `CreateTask` endpoint.
#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Task {
    /// The user-provided name.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub name: Option<String>,

    /// The user-provided description.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub description: Option<String>,

    /// The inputs.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub inputs: Option<Vec<Input>>,

    /// The outputs.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub outputs: Option<Vec<Output>>,

    /// The requested resources.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub resources: Option<Resources>,

    /// The executors of the task.
    pub executors: Vec<Executor>,

    /// The volumes of the task.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub volumes: Option<Vec<String>>,

    /// The tags of the task.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub tags: Option<BTreeMap<String, String>>,
}