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

Interface JobSummary.Builder

    • Method Detail

      • jobArn

        JobSummary.Builder jobArn​(String jobArn)

        The job ARN.

        Parameters:
        jobArn - The job ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobId

        JobSummary.Builder jobId​(String jobId)

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

        Parameters:
        jobId - The unique identifier you assigned to this job when it was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • thingGroupId

        JobSummary.Builder thingGroupId​(String thingGroupId)

        The ID of the thing group.

        Parameters:
        thingGroupId - The ID of the thing group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetSelection

        JobSummary.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

        JobSummary.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

      • status

        JobSummary.Builder status​(String status)

        The job summary status.

        Parameters:
        status - The job summary status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • status

        JobSummary.Builder status​(JobStatus status)

        The job summary status.

        Parameters:
        status - The job summary status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • createdAt

        JobSummary.Builder createdAt​(Instant createdAt)

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

        Parameters:
        createdAt - The time, in seconds since the epoch, when the job was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedAt

        JobSummary.Builder lastUpdatedAt​(Instant lastUpdatedAt)

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

        Parameters:
        lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • completedAt

        JobSummary.Builder completedAt​(Instant completedAt)

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

        Parameters:
        completedAt - The time, in seconds since the epoch, when the job completed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • isConcurrent

        JobSummary.Builder isConcurrent​(Boolean isConcurrent)

        Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

        Parameters:
        isConcurrent - Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.