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

Class JobSummary

    • Method Detail

      • jobArn

        public final String jobArn()

        The job ARN.

        Returns:
        The job ARN.

      • jobId

        public final String jobId()

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

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

      • thingGroupId

        public final String thingGroupId()

        The ID of the thing group.

        Returns:
        The ID of the thing group.

      • targetSelection

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

        Returns:
        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.

        See Also:
        TargetSelection

      • targetSelectionAsString

        public final String targetSelectionAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, targetSelection will return TargetSelection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetSelectionAsString().

        Returns:
        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.

        See Also:
        TargetSelection

      • statusAsString

        public final String statusAsString()

        The job summary status.

        If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The job summary status.
        See Also:
        JobStatus

      • createdAt

        public final Instant createdAt()

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

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

      • lastUpdatedAt

        public final Instant lastUpdatedAt()

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

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

      • completedAt

        public final Instant completedAt()

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

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

      • isConcurrent

        public final 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.

        Returns:
        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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)