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
// 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 CancelJobInput {
/// <p>The unique identifier you assigned to this job when it was created.</p>
pub job_id: ::std::option::Option<::std::string::String>,
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub reason_code: ::std::option::Option<::std::string::String>,
/// <p>An optional comment string describing why the job was canceled.</p>
pub comment: ::std::option::Option<::std::string::String>,
/// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
/// <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>
pub force: ::std::option::Option<bool>,
}
impl CancelJobInput {
/// <p>The unique identifier you assigned to this job when it was created.</p>
pub fn job_id(&self) -> ::std::option::Option<&str> {
self.job_id.as_deref()
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn reason_code(&self) -> ::std::option::Option<&str> {
self.reason_code.as_deref()
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn comment(&self) -> ::std::option::Option<&str> {
self.comment.as_deref()
}
/// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
/// <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>
pub fn force(&self) -> ::std::option::Option<bool> {
self.force
}
}
impl CancelJobInput {
/// Creates a new builder-style object to manufacture [`CancelJobInput`](crate::operation::cancel_job::CancelJobInput).
pub fn builder() -> crate::operation::cancel_job::builders::CancelJobInputBuilder {
crate::operation::cancel_job::builders::CancelJobInputBuilder::default()
}
}
/// A builder for [`CancelJobInput`](crate::operation::cancel_job::CancelJobInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CancelJobInputBuilder {
pub(crate) job_id: ::std::option::Option<::std::string::String>,
pub(crate) reason_code: ::std::option::Option<::std::string::String>,
pub(crate) comment: ::std::option::Option<::std::string::String>,
pub(crate) force: ::std::option::Option<bool>,
}
impl CancelJobInputBuilder {
/// <p>The unique identifier you assigned to this job when it was created.</p>
/// This field is required.
pub fn job_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.job_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier you assigned to this job when it was created.</p>
pub fn set_job_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.job_id = input;
self
}
/// <p>The unique identifier you assigned to this job when it was created.</p>
pub fn get_job_id(&self) -> &::std::option::Option<::std::string::String> {
&self.job_id
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn reason_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.reason_code = ::std::option::Option::Some(input.into());
self
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn set_reason_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.reason_code = input;
self
}
/// <p>(Optional)A reason code string that explains why the job was canceled.</p>
pub fn get_reason_code(&self) -> &::std::option::Option<::std::string::String> {
&self.reason_code
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.comment = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.comment = input;
self
}
/// <p>An optional comment string describing why the job was canceled.</p>
pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
&self.comment
}
/// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
/// <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>
pub fn force(mut self, input: bool) -> Self {
self.force = ::std::option::Option::Some(input);
self
}
/// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
/// <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>
pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
self.force = input;
self
}
/// <p>(Optional) If <code>true</code> job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is <code>false</code>.</p>
/// <p>Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.</p>
pub fn get_force(&self) -> &::std::option::Option<bool> {
&self.force
}
/// Consumes the builder and constructs a [`CancelJobInput`](crate::operation::cancel_job::CancelJobInput).
pub fn build(self) -> ::std::result::Result<crate::operation::cancel_job::CancelJobInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::cancel_job::CancelJobInput {
job_id: self.job_id,
reason_code: self.reason_code,
comment: self.comment,
force: self.force,
})
}
}