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

/*
 * 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
 */

/// JobRequest : 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 JobRequest {
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<uuid::Uuid>,
    /// 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 this job can be executed by users
    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
    pub enabled: 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>,
    /// 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 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 = "tags", skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<crate::models::ApprovalWorkflowStageResponseApprovalWorkflowStage>>,
    #[serde(rename = "custom_fields", skip_serializing_if = "Option::is_none")]
    pub custom_fields: Option<::std::collections::HashMap<String, serde_json::Value>>,
    #[serde(rename = "relationships", skip_serializing_if = "Option::is_none")]
    pub relationships: Option<
        ::std::collections::HashMap<
            String,
            crate::models::ApprovalWorkflowDefinitionRequestRelationshipsValue,
        >,
    >,
}

impl JobRequest {
    /// 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,
    ) -> JobRequest {
        JobRequest {
            id: None,
            grouping,
            name,
            description: None,
            enabled: None,
            has_sensitive_variables: None,
            is_singleton: None,
            console_log_default: None,
            hidden: None,
            dryrun_default: None,
            soft_time_limit: None,
            time_limit: 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),
            tags: None,
            custom_fields: None,
            relationships: None,
        }
    }
}