Class JobProcessDetails

java.lang.Object
software.amazon.awssdk.services.iot.model.JobProcessDetails
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>
@Generated("software.amazon.awssdk:codegen") public final class JobProcessDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>

The job process details.

See Also:

  • Method Details

    • hasProcessingTargets

      public final boolean hasProcessingTargets()
      For responses, this returns true if the service returned a value for the ProcessingTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • processingTargets

      public final List<String> processingTargets()

      The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProcessingTargets() method.

      Returns:
      The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

    • numberOfCanceledThings

      public final Integer numberOfCanceledThings()

      The number of things that cancelled the job.

      Returns:
      The number of things that cancelled the job.

    • numberOfSucceededThings

      public final Integer numberOfSucceededThings()

      The number of things which successfully completed the job.

      Returns:
      The number of things which successfully completed the job.

    • numberOfFailedThings

      public final Integer numberOfFailedThings()

      The number of things that failed executing the job.

      Returns:
      The number of things that failed executing the job.

    • numberOfRejectedThings

      public final Integer numberOfRejectedThings()

      The number of things that rejected the job.

      Returns:
      The number of things that rejected the job.

    • numberOfQueuedThings

      public final Integer numberOfQueuedThings()

      The number of things that are awaiting execution of the job.

      Returns:
      The number of things that are awaiting execution of the job.

    • numberOfInProgressThings

      public final Integer numberOfInProgressThings()

      The number of things currently executing the job.

      Returns:
      The number of things currently executing the job.

    • numberOfRemovedThings

      public final Integer numberOfRemovedThings()

      The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.

      Returns:
      The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.

    • numberOfTimedOutThings

      public final Integer numberOfTimedOutThings()

      The number of things whose job execution status is TIMED_OUT.

      Returns:
      The number of things whose job execution status is TIMED_OUT.

    • toBuilder

      public JobProcessDetails.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>
      Returns:
      a builder for type T

    • builder

      public static JobProcessDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobProcessDetails.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.