aws-sdk-omics 1.119.0

AWS SDK for Amazon Omics
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetRunTaskOutput {
    /// <p>The task's ID.</p>
    pub task_id: ::std::option::Option<::std::string::String>,
    /// <p>The task's status.</p>
    pub status: ::std::option::Option<crate::types::TaskStatus>,
    /// <p>The task's name.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The task's CPU usage.</p>
    pub cpus: ::std::option::Option<i32>,
    /// <p>Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.</p>
    pub cache_hit: ::std::option::Option<bool>,
    /// <p>The S3 URI of the cache location.</p>
    pub cache_s3_uri: ::std::option::Option<::std::string::String>,
    /// <p>The task's memory use in gigabytes.</p>
    pub memory: ::std::option::Option<i32>,
    /// <p>When the task was created.</p>
    pub creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The task's start time.</p>
    pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The task's stop time.</p>
    pub stop_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The task's status message.</p>
    pub status_message: ::std::option::Option<::std::string::String>,
    /// <p>The task's log stream.</p>
    pub log_stream: ::std::option::Option<::std::string::String>,
    /// <p>The number of Graphics Processing Units (GPU) specified in the task.</p>
    pub gpus: ::std::option::Option<i32>,
    /// <p>The instance type for a task.</p>
    pub instance_type: ::std::option::Option<::std::string::String>,
    /// <p>The reason a task has failed.</p>
    pub failure_reason: ::std::option::Option<::std::string::String>,
    /// <p>Details about the container image that this task uses.</p>
    pub image_details: ::std::option::Option<crate::types::ImageDetails>,
    /// <p>The universally unique identifier (UUID) for the workflow task.</p>
    pub uuid: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetRunTaskOutput {
    /// <p>The task's ID.</p>
    pub fn task_id(&self) -> ::std::option::Option<&str> {
        self.task_id.as_deref()
    }
    /// <p>The task's status.</p>
    pub fn status(&self) -> ::std::option::Option<&crate::types::TaskStatus> {
        self.status.as_ref()
    }
    /// <p>The task's name.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The task's CPU usage.</p>
    pub fn cpus(&self) -> ::std::option::Option<i32> {
        self.cpus
    }
    /// <p>Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.</p>
    pub fn cache_hit(&self) -> ::std::option::Option<bool> {
        self.cache_hit
    }
    /// <p>The S3 URI of the cache location.</p>
    pub fn cache_s3_uri(&self) -> ::std::option::Option<&str> {
        self.cache_s3_uri.as_deref()
    }
    /// <p>The task's memory use in gigabytes.</p>
    pub fn memory(&self) -> ::std::option::Option<i32> {
        self.memory
    }
    /// <p>When the task was created.</p>
    pub fn creation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.creation_time.as_ref()
    }
    /// <p>The task's start time.</p>
    pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.start_time.as_ref()
    }
    /// <p>The task's stop time.</p>
    pub fn stop_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.stop_time.as_ref()
    }
    /// <p>The task's status message.</p>
    pub fn status_message(&self) -> ::std::option::Option<&str> {
        self.status_message.as_deref()
    }
    /// <p>The task's log stream.</p>
    pub fn log_stream(&self) -> ::std::option::Option<&str> {
        self.log_stream.as_deref()
    }
    /// <p>The number of Graphics Processing Units (GPU) specified in the task.</p>
    pub fn gpus(&self) -> ::std::option::Option<i32> {
        self.gpus
    }
    /// <p>The instance type for a task.</p>
    pub fn instance_type(&self) -> ::std::option::Option<&str> {
        self.instance_type.as_deref()
    }
    /// <p>The reason a task has failed.</p>
    pub fn failure_reason(&self) -> ::std::option::Option<&str> {
        self.failure_reason.as_deref()
    }
    /// <p>Details about the container image that this task uses.</p>
    pub fn image_details(&self) -> ::std::option::Option<&crate::types::ImageDetails> {
        self.image_details.as_ref()
    }
    /// <p>The universally unique identifier (UUID) for the workflow task.</p>
    pub fn uuid(&self) -> ::std::option::Option<&str> {
        self.uuid.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for GetRunTaskOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetRunTaskOutput {
    /// Creates a new builder-style object to manufacture [`GetRunTaskOutput`](crate::operation::get_run_task::GetRunTaskOutput).
    pub fn builder() -> crate::operation::get_run_task::builders::GetRunTaskOutputBuilder {
        crate::operation::get_run_task::builders::GetRunTaskOutputBuilder::default()
    }
}

/// A builder for [`GetRunTaskOutput`](crate::operation::get_run_task::GetRunTaskOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetRunTaskOutputBuilder {
    pub(crate) task_id: ::std::option::Option<::std::string::String>,
    pub(crate) status: ::std::option::Option<crate::types::TaskStatus>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) cpus: ::std::option::Option<i32>,
    pub(crate) cache_hit: ::std::option::Option<bool>,
    pub(crate) cache_s3_uri: ::std::option::Option<::std::string::String>,
    pub(crate) memory: ::std::option::Option<i32>,
    pub(crate) creation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) stop_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) status_message: ::std::option::Option<::std::string::String>,
    pub(crate) log_stream: ::std::option::Option<::std::string::String>,
    pub(crate) gpus: ::std::option::Option<i32>,
    pub(crate) instance_type: ::std::option::Option<::std::string::String>,
    pub(crate) failure_reason: ::std::option::Option<::std::string::String>,
    pub(crate) image_details: ::std::option::Option<crate::types::ImageDetails>,
    pub(crate) uuid: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetRunTaskOutputBuilder {
    /// <p>The task's ID.</p>
    pub fn task_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.task_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The task's ID.</p>
    pub fn set_task_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.task_id = input;
        self
    }
    /// <p>The task's ID.</p>
    pub fn get_task_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.task_id
    }
    /// <p>The task's status.</p>
    pub fn status(mut self, input: crate::types::TaskStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The task's status.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::TaskStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The task's status.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::TaskStatus> {
        &self.status
    }
    /// <p>The task's name.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The task's name.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The task's name.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The task's CPU usage.</p>
    pub fn cpus(mut self, input: i32) -> Self {
        self.cpus = ::std::option::Option::Some(input);
        self
    }
    /// <p>The task's CPU usage.</p>
    pub fn set_cpus(mut self, input: ::std::option::Option<i32>) -> Self {
        self.cpus = input;
        self
    }
    /// <p>The task's CPU usage.</p>
    pub fn get_cpus(&self) -> &::std::option::Option<i32> {
        &self.cpus
    }
    /// <p>Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.</p>
    pub fn cache_hit(mut self, input: bool) -> Self {
        self.cache_hit = ::std::option::Option::Some(input);
        self
    }
    /// <p>Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.</p>
    pub fn set_cache_hit(mut self, input: ::std::option::Option<bool>) -> Self {
        self.cache_hit = input;
        self
    }
    /// <p>Set to true if Amazon Web Services HealthOmics found a matching entry in the run cache for this task.</p>
    pub fn get_cache_hit(&self) -> &::std::option::Option<bool> {
        &self.cache_hit
    }
    /// <p>The S3 URI of the cache location.</p>
    pub fn cache_s3_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cache_s3_uri = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The S3 URI of the cache location.</p>
    pub fn set_cache_s3_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cache_s3_uri = input;
        self
    }
    /// <p>The S3 URI of the cache location.</p>
    pub fn get_cache_s3_uri(&self) -> &::std::option::Option<::std::string::String> {
        &self.cache_s3_uri
    }
    /// <p>The task's memory use in gigabytes.</p>
    pub fn memory(mut self, input: i32) -> Self {
        self.memory = ::std::option::Option::Some(input);
        self
    }
    /// <p>The task's memory use in gigabytes.</p>
    pub fn set_memory(mut self, input: ::std::option::Option<i32>) -> Self {
        self.memory = input;
        self
    }
    /// <p>The task's memory use in gigabytes.</p>
    pub fn get_memory(&self) -> &::std::option::Option<i32> {
        &self.memory
    }
    /// <p>When the task was created.</p>
    pub fn creation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.creation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>When the task was created.</p>
    pub fn set_creation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.creation_time = input;
        self
    }
    /// <p>When the task was created.</p>
    pub fn get_creation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.creation_time
    }
    /// <p>The task's start time.</p>
    pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.start_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The task's start time.</p>
    pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.start_time = input;
        self
    }
    /// <p>The task's start time.</p>
    pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.start_time
    }
    /// <p>The task's stop time.</p>
    pub fn stop_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.stop_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The task's stop time.</p>
    pub fn set_stop_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.stop_time = input;
        self
    }
    /// <p>The task's stop time.</p>
    pub fn get_stop_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.stop_time
    }
    /// <p>The task's status message.</p>
    pub fn status_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.status_message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The task's status message.</p>
    pub fn set_status_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.status_message = input;
        self
    }
    /// <p>The task's status message.</p>
    pub fn get_status_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.status_message
    }
    /// <p>The task's log stream.</p>
    pub fn log_stream(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.log_stream = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The task's log stream.</p>
    pub fn set_log_stream(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.log_stream = input;
        self
    }
    /// <p>The task's log stream.</p>
    pub fn get_log_stream(&self) -> &::std::option::Option<::std::string::String> {
        &self.log_stream
    }
    /// <p>The number of Graphics Processing Units (GPU) specified in the task.</p>
    pub fn gpus(mut self, input: i32) -> Self {
        self.gpus = ::std::option::Option::Some(input);
        self
    }
    /// <p>The number of Graphics Processing Units (GPU) specified in the task.</p>
    pub fn set_gpus(mut self, input: ::std::option::Option<i32>) -> Self {
        self.gpus = input;
        self
    }
    /// <p>The number of Graphics Processing Units (GPU) specified in the task.</p>
    pub fn get_gpus(&self) -> &::std::option::Option<i32> {
        &self.gpus
    }
    /// <p>The instance type for a task.</p>
    pub fn instance_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.instance_type = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The instance type for a task.</p>
    pub fn set_instance_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.instance_type = input;
        self
    }
    /// <p>The instance type for a task.</p>
    pub fn get_instance_type(&self) -> &::std::option::Option<::std::string::String> {
        &self.instance_type
    }
    /// <p>The reason a task has failed.</p>
    pub fn failure_reason(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.failure_reason = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The reason a task has failed.</p>
    pub fn set_failure_reason(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.failure_reason = input;
        self
    }
    /// <p>The reason a task has failed.</p>
    pub fn get_failure_reason(&self) -> &::std::option::Option<::std::string::String> {
        &self.failure_reason
    }
    /// <p>Details about the container image that this task uses.</p>
    pub fn image_details(mut self, input: crate::types::ImageDetails) -> Self {
        self.image_details = ::std::option::Option::Some(input);
        self
    }
    /// <p>Details about the container image that this task uses.</p>
    pub fn set_image_details(mut self, input: ::std::option::Option<crate::types::ImageDetails>) -> Self {
        self.image_details = input;
        self
    }
    /// <p>Details about the container image that this task uses.</p>
    pub fn get_image_details(&self) -> &::std::option::Option<crate::types::ImageDetails> {
        &self.image_details
    }
    /// <p>The universally unique identifier (UUID) for the workflow task.</p>
    pub fn uuid(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.uuid = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The universally unique identifier (UUID) for the workflow task.</p>
    pub fn set_uuid(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.uuid = input;
        self
    }
    /// <p>The universally unique identifier (UUID) for the workflow task.</p>
    pub fn get_uuid(&self) -> &::std::option::Option<::std::string::String> {
        &self.uuid
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`GetRunTaskOutput`](crate::operation::get_run_task::GetRunTaskOutput).
    pub fn build(self) -> crate::operation::get_run_task::GetRunTaskOutput {
        crate::operation::get_run_task::GetRunTaskOutput {
            task_id: self.task_id,
            status: self.status,
            name: self.name,
            cpus: self.cpus,
            cache_hit: self.cache_hit,
            cache_s3_uri: self.cache_s3_uri,
            memory: self.memory,
            creation_time: self.creation_time,
            start_time: self.start_time,
            stop_time: self.stop_time,
            status_message: self.status_message,
            log_stream: self.log_stream,
            gpus: self.gpus,
            instance_type: self.instance_type,
            failure_reason: self.failure_reason,
            image_details: self.image_details,
            uuid: self.uuid,
            _request_id: self._request_id,
        }
    }
}