tapis-systems 0.3.0

The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
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

/*
 * Tapis Systems API
 *
 * The Tapis Systems API provides for management of Tapis Systems including permissions, credentials and Scheduler Profiles.
 *
 * The version of the OpenAPI document: 25Q4.2
 * Contact: cicsupport@tacc.utexas.edu
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ReqPostSystem {
    /// Short descriptive name for the system that is unique within the tenant.
    #[serde(rename = "id")]
    pub id: String,
    /// Optional more verbose description.
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(rename = "systemType")]
    pub system_type: models::SystemTypeEnum,
    /// A specific user set at system creation.
    #[serde(rename = "owner", skip_serializing_if = "Option::is_none")]
    pub owner: Option<String>,
    /// FQDN, IP address, Globus endpoint ID or Globus collection ID.
    #[serde(rename = "host")]
    pub host: String,
    /// Indicates if system is currently considered active and available for use.
    #[serde(rename = "enabled", skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Username to use when accessing the system. A specific user (such as a service account) or the dynamic user ``${apiUserId}``.
    #[serde(rename = "effectiveUserId", skip_serializing_if = "Option::is_none")]
    pub effective_user_id: Option<String>,
    #[serde(rename = "defaultAuthnMethod")]
    pub default_authn_method: models::AuthnEnum,
    #[serde(rename = "authnCredential", skip_serializing_if = "Option::is_none")]
    pub authn_credential: Option<Box<models::ReqPostPutCredential>>,
    /// Name of the bucket for an S3 type system.
    #[serde(rename = "bucketName", skip_serializing_if = "Option::is_none")]
    pub bucket_name: Option<String>,
    /// Effective root directory to be used when listing files or moving files to and from the system.
    #[serde(rename = "rootDir", skip_serializing_if = "Option::is_none")]
    pub root_dir: Option<String>,
    #[serde(rename = "port", skip_serializing_if = "Option::is_none")]
    pub port: Option<i32>,
    #[serde(rename = "useProxy", skip_serializing_if = "Option::is_none")]
    pub use_proxy: Option<bool>,
    #[serde(rename = "proxyHost", skip_serializing_if = "Option::is_none")]
    pub proxy_host: Option<String>,
    #[serde(rename = "proxyPort", skip_serializing_if = "Option::is_none")]
    pub proxy_port: Option<i32>,
    /// An alternate system to use as a Data Transfer Node (DTN) during job execution.
    #[serde(rename = "dtnSystemId", skip_serializing_if = "Option::is_none")]
    pub dtn_system_id: Option<String>,
    /// Indicates if system can be used to execute jobs.
    #[serde(rename = "canExec")]
    pub can_exec: bool,
    /// Indicates if system supports running jobs using a batch scheduler.
    #[serde(rename = "canRunBatch", skip_serializing_if = "Option::is_none")]
    pub can_run_batch: Option<bool>,
    /// Indicates if system allows a job submission request to specify a *cmdPrefix*.
    #[serde(rename = "enableCmdPrefix", skip_serializing_if = "Option::is_none")]
    pub enable_cmd_prefix: Option<bool>,
    /// Indicates if system allows for the creation of child systems.
    #[serde(rename = "allowChildren", skip_serializing_if = "Option::is_none")]
    pub allow_children: Option<bool>,
    #[serde(rename = "mpiCmd", skip_serializing_if = "Option::is_none")]
    pub mpi_cmd: Option<String>,
    #[serde(rename = "jobRuntimes", skip_serializing_if = "Option::is_none")]
    pub job_runtimes: Option<Vec<models::JobRuntime>>,
    #[serde(rename = "jobWorkingDir", skip_serializing_if = "Option::is_none")]
    pub job_working_dir: Option<String>,
    #[serde(rename = "jobEnvVariables", skip_serializing_if = "Option::is_none")]
    pub job_env_variables: Option<Vec<models::KeyValuePair>>,
    #[serde(rename = "jobMaxJobs", skip_serializing_if = "Option::is_none")]
    pub job_max_jobs: Option<i32>,
    #[serde(rename = "jobMaxJobsPerUser", skip_serializing_if = "Option::is_none")]
    pub job_max_jobs_per_user: Option<i32>,
    #[serde(rename = "batchScheduler", skip_serializing_if = "Option::is_none")]
    pub batch_scheduler: Option<models::SchedulerTypeEnum>,
    #[serde(rename = "batchLogicalQueues", skip_serializing_if = "Option::is_none")]
    pub batch_logical_queues: Option<Vec<models::LogicalQueue>>,
    #[serde(
        rename = "batchDefaultLogicalQueue",
        skip_serializing_if = "Option::is_none"
    )]
    pub batch_default_logical_queue: Option<String>,
    #[serde(
        rename = "batchSchedulerProfile",
        skip_serializing_if = "Option::is_none"
    )]
    pub batch_scheduler_profile: Option<String>,
    #[serde(rename = "jobCapabilities", skip_serializing_if = "Option::is_none")]
    pub job_capabilities: Option<Vec<models::Capability>>,
    /// List of tags as simple strings.
    #[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<String>>,
    /// Metadata in the form of a Json object. Not used by Tapis.
    #[serde(rename = "notes", skip_serializing_if = "Option::is_none")]
    pub notes: Option<serde_json::Value>,
}

impl ReqPostSystem {
    pub fn new(
        id: String,
        system_type: models::SystemTypeEnum,
        host: String,
        default_authn_method: models::AuthnEnum,
        can_exec: bool,
    ) -> ReqPostSystem {
        ReqPostSystem {
            id,
            description: None,
            system_type,
            owner: None,
            host,
            enabled: None,
            effective_user_id: None,
            default_authn_method,
            authn_credential: None,
            bucket_name: None,
            root_dir: None,
            port: None,
            use_proxy: None,
            proxy_host: None,
            proxy_port: None,
            dtn_system_id: None,
            can_exec,
            can_run_batch: None,
            enable_cmd_prefix: None,
            allow_children: None,
            mpi_cmd: None,
            job_runtimes: None,
            job_working_dir: None,
            job_env_variables: None,
            job_max_jobs: None,
            job_max_jobs_per_user: None,
            batch_scheduler: None,
            batch_logical_queues: None,
            batch_default_logical_queue: None,
            batch_scheduler_profile: None,
            job_capabilities: None,
            tags: None,
            notes: None,
        }
    }
}