Package software.amazon.awssdk.services.iot.model

Interface CreateJobRequest.Builder

    • Method Detail

      • jobId

        CreateJobRequest.Builder jobId​(String jobId)

        A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

        Parameters:
        jobId - A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        CreateJobRequest.Builder targets​(Collection<String> targets)

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

        Parameters:
        targets - A list of things and thing groups to which the job should be sent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targets

        CreateJobRequest.Builder targets​(String... targets)

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

        Parameters:
        targets - A list of things and thing groups to which the job should be sent.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentSource

        CreateJobRequest.Builder documentSource​(String documentSource)

        An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

        For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

        For more information, see Methods for accessing a bucket.

        Parameters:
        documentSource - An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

        For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

        For more information, see Methods for accessing a bucket.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • document

        CreateJobRequest.Builder document​(String document)

        The job document. Required if you don't specify a value for documentSource.

        Parameters:
        document - The job document. Required if you don't specify a value for documentSource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateJobRequest.Builder description​(String description)

        A short text description of the job.

        Parameters:
        description - A short text description of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • presignedUrlConfig

        CreateJobRequest.Builder presignedUrlConfig​(PresignedUrlConfig presignedUrlConfig)

        Configuration information for pre-signed S3 URLs.

        Parameters:
        presignedUrlConfig - Configuration information for pre-signed S3 URLs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetSelection

        CreateJobRequest.Builder targetSelection​(String targetSelection)

        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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

        Parameters:
        targetSelection - 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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TargetSelection, TargetSelection

      • targetSelection

        CreateJobRequest.Builder targetSelection​(TargetSelection targetSelection)

        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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

        Parameters:
        targetSelection - 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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

        We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TargetSelection, TargetSelection

      • jobExecutionsRolloutConfig

        CreateJobRequest.Builder jobExecutionsRolloutConfig​(JobExecutionsRolloutConfig jobExecutionsRolloutConfig)

        Allows you to create a staged rollout of the job.

        Parameters:
        jobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • abortConfig

        CreateJobRequest.Builder abortConfig​(AbortConfig abortConfig)

        Allows you to create the criteria to abort a job.

        Parameters:
        abortConfig - Allows you to create the criteria to abort a job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeoutConfig

        CreateJobRequest.Builder timeoutConfig​(TimeoutConfig timeoutConfig)

        Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.

        Parameters:
        timeoutConfig - Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to TIMED_OUT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateJobRequest.Builder tags​(Collection<Tag> tags)

        Metadata which can be used to manage the job.

        Parameters:
        tags - Metadata which can be used to manage the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateJobRequest.Builder tags​(Tag... tags)

        Metadata which can be used to manage the job.

        Parameters:
        tags - Metadata which can be used to manage the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateJobRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Metadata which can be used to manage the job.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • namespaceId

        CreateJobRequest.Builder namespaceId​(String namespaceId)

        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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

        Parameters:
        namespaceId - 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 only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobTemplateArn

        CreateJobRequest.Builder jobTemplateArn​(String jobTemplateArn)

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

        Parameters:
        jobTemplateArn - The ARN of the job template used to create the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobExecutionsRetryConfig

        CreateJobRequest.Builder jobExecutionsRetryConfig​(JobExecutionsRetryConfig jobExecutionsRetryConfig)

        Allows you to create the criteria to retry a job.

        Parameters:
        jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentParameters

        CreateJobRequest.Builder documentParameters​(Map<String,​String> documentParameters)

        Parameters of an Amazon Web Services managed template that you can specify to create the job document.

        documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

        Parameters:
        documentParameters - Parameters of an Amazon Web Services managed template that you can specify to create the job document.

        documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schedulingConfig

        CreateJobRequest.Builder schedulingConfig​(SchedulingConfig schedulingConfig)

        The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

        Parameters:
        schedulingConfig - The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationPackageVersions

        CreateJobRequest.Builder destinationPackageVersions​(Collection<String> destinationPackageVersions)

        The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

        Parameters:
        destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationPackageVersions

        CreateJobRequest.Builder destinationPackageVersions​(String... destinationPackageVersions)

        The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

        Parameters:
        destinationPackageVersions - The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

        Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

        Returns:
        Returns a reference to this object so that method calls can be chained together.