Struct aws_sdk_iotjobsdataplane::operation::update_job_execution::builders::UpdateJobExecutionInputBuilder
source · #[non_exhaustive]pub struct UpdateJobExecutionInputBuilder { /* private fields */ }
Expand description
A builder for UpdateJobExecutionInput
.
Implementations§
source§impl UpdateJobExecutionInputBuilder
impl UpdateJobExecutionInputBuilder
sourcepub fn job_id(self, input: impl Into<String>) -> Self
pub fn job_id(self, input: impl Into<String>) -> Self
The unique identifier assigned to this job when it was created.
This field is required.sourcepub fn set_job_id(self, input: Option<String>) -> Self
pub fn set_job_id(self, input: Option<String>) -> Self
The unique identifier assigned to this job when it was created.
sourcepub fn get_job_id(&self) -> &Option<String>
pub fn get_job_id(&self) -> &Option<String>
The unique identifier assigned to this job when it was created.
sourcepub fn thing_name(self, input: impl Into<String>) -> Self
pub fn thing_name(self, input: impl Into<String>) -> Self
The name of the thing associated with the device.
This field is required.sourcepub fn set_thing_name(self, input: Option<String>) -> Self
pub fn set_thing_name(self, input: Option<String>) -> Self
The name of the thing associated with the device.
sourcepub fn get_thing_name(&self) -> &Option<String>
pub fn get_thing_name(&self) -> &Option<String>
The name of the thing associated with the device.
sourcepub fn status(self, input: JobExecutionStatus) -> Self
pub fn status(self, input: JobExecutionStatus) -> Self
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
This field is required.sourcepub fn set_status(self, input: Option<JobExecutionStatus>) -> Self
pub fn set_status(self, input: Option<JobExecutionStatus>) -> Self
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
sourcepub fn get_status(&self) -> &Option<JobExecutionStatus>
pub fn get_status(&self) -> &Option<JobExecutionStatus>
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
sourcepub fn status_details(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn status_details(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to status_details
.
To override the contents of this collection use set_status_details
.
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
sourcepub fn set_status_details(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_status_details(self, input: Option<HashMap<String, String>>) -> Self
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
sourcepub fn get_status_details(&self) -> &Option<HashMap<String, String>>
pub fn get_status_details(&self) -> &Option<HashMap<String, String>>
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
sourcepub fn step_timeout_in_minutes(self, input: i64) -> Self
pub fn step_timeout_in_minutes(self, input: i64) -> Self
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution
, setting the status to IN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using field timeoutConfig
).
sourcepub fn set_step_timeout_in_minutes(self, input: Option<i64>) -> Self
pub fn set_step_timeout_in_minutes(self, input: Option<i64>) -> Self
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution
, setting the status to IN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using field timeoutConfig
).
sourcepub fn get_step_timeout_in_minutes(&self) -> &Option<i64>
pub fn get_step_timeout_in_minutes(&self) -> &Option<i64>
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution
, setting the status to IN_PROGRESS
and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT
. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob
using field timeoutConfig
).
sourcepub fn expected_version(self, input: i64) -> Self
pub fn expected_version(self, input: i64) -> Self
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn set_expected_version(self, input: Option<i64>) -> Self
pub fn set_expected_version(self, input: Option<i64>) -> Self
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn get_expected_version(&self) -> &Option<i64>
pub fn get_expected_version(&self) -> &Option<i64>
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
sourcepub fn include_job_execution_state(self, input: bool) -> Self
pub fn include_job_execution_state(self, input: bool) -> Self
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
sourcepub fn set_include_job_execution_state(self, input: Option<bool>) -> Self
pub fn set_include_job_execution_state(self, input: Option<bool>) -> Self
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
sourcepub fn get_include_job_execution_state(&self) -> &Option<bool>
pub fn get_include_job_execution_state(&self) -> &Option<bool>
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
sourcepub fn include_job_document(self, input: bool) -> Self
pub fn include_job_document(self, input: bool) -> Self
Optional. When set to true, the response contains the job document. The default is false.
sourcepub fn set_include_job_document(self, input: Option<bool>) -> Self
pub fn set_include_job_document(self, input: Option<bool>) -> Self
Optional. When set to true, the response contains the job document. The default is false.
sourcepub fn get_include_job_document(&self) -> &Option<bool>
pub fn get_include_job_document(&self) -> &Option<bool>
Optional. When set to true, the response contains the job document. The default is false.
sourcepub fn execution_number(self, input: i64) -> Self
pub fn execution_number(self, input: i64) -> Self
Optional. A number that identifies a particular job execution on a particular device.
sourcepub fn set_execution_number(self, input: Option<i64>) -> Self
pub fn set_execution_number(self, input: Option<i64>) -> Self
Optional. A number that identifies a particular job execution on a particular device.
sourcepub fn get_execution_number(&self) -> &Option<i64>
pub fn get_execution_number(&self) -> &Option<i64>
Optional. A number that identifies a particular job execution on a particular device.
sourcepub fn build(self) -> Result<UpdateJobExecutionInput, BuildError>
pub fn build(self) -> Result<UpdateJobExecutionInput, BuildError>
Consumes the builder and constructs a UpdateJobExecutionInput
.
source§impl UpdateJobExecutionInputBuilder
impl UpdateJobExecutionInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<UpdateJobExecutionOutput, SdkError<UpdateJobExecutionError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<UpdateJobExecutionOutput, SdkError<UpdateJobExecutionError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for UpdateJobExecutionInputBuilder
impl Clone for UpdateJobExecutionInputBuilder
source§fn clone(&self) -> UpdateJobExecutionInputBuilder
fn clone(&self) -> UpdateJobExecutionInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for UpdateJobExecutionInputBuilder
impl Default for UpdateJobExecutionInputBuilder
source§fn default() -> UpdateJobExecutionInputBuilder
fn default() -> UpdateJobExecutionInputBuilder
source§impl PartialEq for UpdateJobExecutionInputBuilder
impl PartialEq for UpdateJobExecutionInputBuilder
source§fn eq(&self, other: &UpdateJobExecutionInputBuilder) -> bool
fn eq(&self, other: &UpdateJobExecutionInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UpdateJobExecutionInputBuilder
Auto Trait Implementations§
impl Freeze for UpdateJobExecutionInputBuilder
impl RefUnwindSafe for UpdateJobExecutionInputBuilder
impl Send for UpdateJobExecutionInputBuilder
impl Sync for UpdateJobExecutionInputBuilder
impl Unpin for UpdateJobExecutionInputBuilder
impl UnwindSafe for UpdateJobExecutionInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more