Struct aws_sdk_iot::model::job::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for Job

Implementations

impl Builder

pub fn job_arn(self, input: impl Into<String>) -> Self

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

pub fn set_job_arn(self, input: Option<String>) -> Self

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

pub fn job_id(self, input: impl Into<String>) -> Self

The unique identifier you assigned to this job when it was created.

pub fn set_job_id(self, input: Option<String>) -> Self

The unique identifier you assigned to this job when it was created.

pub fn target_selection(self, input: TargetSelection) -> Self

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

pub fn set_target_selection(self, input: Option<TargetSelection>) -> Self

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

pub fn status(self, input: JobStatus) -> Self

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

pub fn set_status(self, input: Option<JobStatus>) -> Self

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

pub fn force_canceled(self, input: bool) -> Self

Will be true if the job was canceled with the optional force parameter set to true.

pub fn set_force_canceled(self, input: Option<bool>) -> Self

Will be true if the job was canceled with the optional force parameter set to true.

pub fn reason_code(self, input: impl Into<String>) -> Self

If the job was updated, provides the reason code for the update.

pub fn set_reason_code(self, input: Option<String>) -> Self

If the job was updated, provides the reason code for the update.

pub fn comment(self, input: impl Into<String>) -> Self

If the job was updated, describes the reason for the update.

pub fn set_comment(self, input: Option<String>) -> Self

If the job was updated, describes the reason for the update.

pub fn targets(self, input: impl Into<String>) -> Self

Appends an item to targets.

To override the contents of this collection use set_targets.

A list of IoT things and thing groups to which the job should be sent.

pub fn set_targets(self, input: Option<Vec<String>>) -> Self

A list of IoT things and thing groups to which the job should be sent.

pub fn description(self, input: impl Into<String>) -> Self

A short text description of the job.

pub fn set_description(self, input: Option<String>) -> Self

A short text description of the job.

pub fn presigned_url_config(self, input: PresignedUrlConfig) -> Self

Configuration for pre-signed S3 URLs.

pub fn set_presigned_url_config(self, input: Option<PresignedUrlConfig>) -> Self

Configuration for pre-signed S3 URLs.

pub fn job_executions_rollout_config(
    self,
    input: JobExecutionsRolloutConfig
) -> Self

Allows you to create a staged rollout of a job.

pub fn set_job_executions_rollout_config(
    self,
    input: Option<JobExecutionsRolloutConfig>
) -> Self

Allows you to create a staged rollout of a job.

pub fn abort_config(self, input: AbortConfig) -> Self

Configuration for criteria to abort the job.

pub fn set_abort_config(self, input: Option<AbortConfig>) -> Self

Configuration for criteria to abort the job.

pub fn created_at(self, input: DateTime) -> Self

The time, in seconds since the epoch, when the job was created.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The time, in seconds since the epoch, when the job was created.

pub fn last_updated_at(self, input: DateTime) -> Self

The time, in seconds since the epoch, when the job was last updated.

pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self

The time, in seconds since the epoch, when the job was last updated.

pub fn completed_at(self, input: DateTime) -> Self

The time, in seconds since the epoch, when the job was completed.

pub fn set_completed_at(self, input: Option<DateTime>) -> Self

The time, in seconds since the epoch, when the job was completed.

pub fn job_process_details(self, input: JobProcessDetails) -> Self

Details about the job process.

pub fn set_job_process_details(self, input: Option<JobProcessDetails>) -> Self

Details about the job process.

pub fn timeout_config(self, input: TimeoutConfig) -> Self

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

pub fn set_timeout_config(self, input: Option<TimeoutConfig>) -> Self

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

pub fn namespace_id(self, input: impl Into<String>) -> Self

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

pub fn set_namespace_id(self, input: Option<String>) -> Self

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

pub fn job_template_arn(self, input: impl Into<String>) -> Self

The ARN of the job template used to create the job.

pub fn set_job_template_arn(self, input: Option<String>) -> Self

The ARN of the job template used to create the job.

pub fn job_executions_retry_config(
    self,
    input: JobExecutionsRetryConfig
) -> Self

The configuration for the criteria to retry the job.

pub fn set_job_executions_retry_config(
    self,
    input: Option<JobExecutionsRetryConfig>
) -> Self

The configuration for the criteria to retry the job.

pub fn document_parameters(
    self,
    k: impl Into<String>,
    v: impl Into<String>
) -> Self

Adds a key-value pair to document_parameters.

To override the contents of this collection use set_document_parameters.

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

pub fn set_document_parameters(
    self,
    input: Option<HashMap<String, String>>
) -> Self

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

pub fn build(self) -> Job

Consumes the builder and constructs a Job

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder