nautobot-openapi 0.4.0

low level nautobot bindings (generated by openapi-generator)
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244

/*
 * API Documentation
 *
 * Source of truth and network automation platform
 *
 * The version of the OpenAPI document: 3.1.0 (3.1)
 *
 * Generated by: https://openapi-generator.tech
 */

/// Job : Base class to use for serializers based on OrganizationalModel or PrimaryModel.  Can also be used for models derived from BaseModel, so long as they support custom fields, notes, and relationships.

#[derive(Clone, Debug, PartialEq, Default, Serialize, Deserialize)]
pub struct Job {
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<uuid::Uuid>,
    #[serde(rename = "object_type", skip_serializing_if = "Option::is_none")]
    pub object_type: Option<String>,
    /// Human friendly display value
    #[serde(rename = "display", skip_serializing_if = "Option::is_none")]
    pub display: Option<String>,
    #[serde(rename = "url", skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    #[serde(rename = "natural_slug", skip_serializing_if = "Option::is_none")]
    pub natural_slug: Option<String>,
    #[serde(
        rename = "task_queues",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub task_queues: Option<Option<serde_json::Value>>,
    #[serde(
        rename = "task_queues_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub task_queues_override: Option<bool>,
    /// Dotted name of the Python module providing this job
    #[serde(rename = "module_name", skip_serializing_if = "Option::is_none")]
    pub module_name: Option<String>,
    /// Name of the Python class providing this job
    #[serde(rename = "job_class_name", skip_serializing_if = "Option::is_none")]
    pub job_class_name: Option<String>,
    /// Human-readable grouping that this job belongs to
    #[serde(rename = "grouping")]
    pub grouping: String,
    /// Human-readable name of this job
    #[serde(rename = "name")]
    pub name: String,
    /// Markdown formatting and a limited subset of HTML are supported
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Whether the Python module and class providing this job are presently installed and loadable
    #[serde(rename = "installed", skip_serializing_if = "Option::is_none")]
    pub installed: Option<bool>,
    /// Whether this job can be executed by users
    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Whether this job is a job hook receiver
    #[serde(
        rename = "is_job_hook_receiver",
        skip_serializing_if = "Option::is_none"
    )]
    pub is_job_hook_receiver: Option<bool>,
    /// Whether this job is a job button receiver
    #[serde(
        rename = "is_job_button_receiver",
        skip_serializing_if = "Option::is_none"
    )]
    pub is_job_button_receiver: Option<bool>,
    /// Whether this job contains sensitive variables
    #[serde(
        rename = "has_sensitive_variables",
        skip_serializing_if = "Option::is_none"
    )]
    pub has_sensitive_variables: Option<bool>,
    /// Whether this job should fail to run if another instance of this job is already running
    #[serde(rename = "is_singleton", skip_serializing_if = "Option::is_none")]
    pub is_singleton: Option<bool>,
    /// Whether the job defaults to running with console log argument set to true
    #[serde(
        rename = "console_log_default",
        skip_serializing_if = "Option::is_none"
    )]
    pub console_log_default: Option<bool>,
    /// Whether the job defaults to not being shown in the UI
    #[serde(rename = "hidden", skip_serializing_if = "Option::is_none")]
    pub hidden: Option<bool>,
    /// Whether the job defaults to running with dryrun argument set to true
    #[serde(rename = "dryrun_default", skip_serializing_if = "Option::is_none")]
    pub dryrun_default: Option<bool>,
    /// Set to true if the job does not make any changes to the environment
    #[serde(rename = "read_only", skip_serializing_if = "Option::is_none")]
    pub read_only: Option<bool>,
    /// Maximum runtime in seconds before the job will receive a <code>SoftTimeLimitExceeded</code> exception.<br>Set to 0 to use Nautobot system default
    #[serde(rename = "soft_time_limit", skip_serializing_if = "Option::is_none")]
    pub soft_time_limit: Option<f64>,
    /// Maximum runtime in seconds before the job will be forcibly terminated.<br>Set to 0 to use Nautobot system default
    #[serde(rename = "time_limit", skip_serializing_if = "Option::is_none")]
    pub time_limit: Option<f64>,
    /// If supported, allows the job to bypass approval when running with dryrun argument set to true
    #[serde(rename = "supports_dryrun", skip_serializing_if = "Option::is_none")]
    pub supports_dryrun: Option<bool>,
    /// If set, the configured grouping will remain even if the underlying Job source code changes
    #[serde(rename = "grouping_override", skip_serializing_if = "Option::is_none")]
    pub grouping_override: Option<bool>,
    /// If set, the configured name will remain even if the underlying Job source code changes
    #[serde(rename = "name_override", skip_serializing_if = "Option::is_none")]
    pub name_override: Option<bool>,
    /// If set, the configured console log default will remain even if the underlying Job source code changes
    #[serde(
        rename = "console_log_default_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub console_log_default_override: Option<bool>,
    /// If set, the configured description will remain even if the underlying Job source code changes
    #[serde(
        rename = "description_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub description_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "dryrun_default_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub dryrun_default_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(rename = "hidden_override", skip_serializing_if = "Option::is_none")]
    pub hidden_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "soft_time_limit_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub soft_time_limit_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "time_limit_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub time_limit_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "has_sensitive_variables_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub has_sensitive_variables_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "job_queues_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub job_queues_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "default_job_queue_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub default_job_queue_override: Option<bool>,
    /// If set, the configured value will remain even if the underlying Job source code changes
    #[serde(
        rename = "is_singleton_override",
        skip_serializing_if = "Option::is_none"
    )]
    pub is_singleton_override: Option<bool>,
    #[serde(rename = "default_job_queue")]
    pub default_job_queue: Box<crate::models::ApprovalWorkflowStageResponseApprovalWorkflowStage>,
    #[serde(
        rename = "created",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub created: Option<Option<String>>,
    #[serde(
        rename = "last_updated",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub last_updated: Option<Option<String>>,
    #[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<crate::models::ApprovalWorkflowStageResponseApprovalWorkflowStage>>,
    #[serde(rename = "notes_url", skip_serializing_if = "Option::is_none")]
    pub notes_url: Option<String>,
    #[serde(rename = "custom_fields", skip_serializing_if = "Option::is_none")]
    pub custom_fields: Option<::std::collections::HashMap<String, serde_json::Value>>,
}

impl Job {
    /// Base class to use for serializers based on OrganizationalModel or PrimaryModel.  Can also be used for models derived from BaseModel, so long as they support custom fields, notes, and relationships.
    pub fn new(
        grouping: String,
        name: String,
        default_job_queue: crate::models::ApprovalWorkflowStageResponseApprovalWorkflowStage,
    ) -> Job {
        Job {
            id: None,
            object_type: None,
            display: None,
            url: None,
            natural_slug: None,
            task_queues: None,
            task_queues_override: None,
            module_name: None,
            job_class_name: None,
            grouping,
            name,
            description: None,
            installed: None,
            enabled: None,
            is_job_hook_receiver: None,
            is_job_button_receiver: None,
            has_sensitive_variables: None,
            is_singleton: None,
            console_log_default: None,
            hidden: None,
            dryrun_default: None,
            read_only: None,
            soft_time_limit: None,
            time_limit: None,
            supports_dryrun: None,
            grouping_override: None,
            name_override: None,
            console_log_default_override: None,
            description_override: None,
            dryrun_default_override: None,
            hidden_override: None,
            soft_time_limit_override: None,
            time_limit_override: None,
            has_sensitive_variables_override: None,
            job_queues_override: None,
            default_job_queue_override: None,
            is_singleton_override: None,
            default_job_queue: Box::new(default_job_queue),
            created: None,
            last_updated: None,
            tags: None,
            notes_url: None,
            custom_fields: None,
        }
    }
}