Package software.amazon.awssdk.services.iotjobsdataplane.model

Class JobExecution

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

Contains data about a job execution.

See Also:

  • Method Details

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

    • thingName

      public final String thingName()

      The name of the thing that is executing the job.

      Returns:
      The name of the thing that is executing the job.

    • status

      public final JobExecutionStatus status()

      The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

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

      Returns:
      The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".

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

      Returns:
      The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "REJECTED", or "REMOVED".
      See Also:

    • hasStatusDetails

      public final boolean hasStatusDetails()
      For responses, this returns true if the service returned a value for the StatusDetails 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.

    • statusDetails

      public final Map<String,String> statusDetails()

      A collection of name/value pairs that describe the status of the job execution.

      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 hasStatusDetails() method.

      Returns:
      A collection of name/value pairs that describe the status of the job execution.

    • queuedAt

      public final Long queuedAt()

      The time, in milliseconds since the epoch, when the job execution was enqueued.

      Returns:
      The time, in milliseconds since the epoch, when the job execution was enqueued.

    • startedAt

      public final Long startedAt()

      The time, in milliseconds since the epoch, when the job execution was started.

      Returns:
      The time, in milliseconds since the epoch, when the job execution was started.

    • lastUpdatedAt

      public final Long lastUpdatedAt()

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

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

    • approximateSecondsBeforeTimedOut

      public final Long approximateSecondsBeforeTimedOut()

      The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

      Returns:
      The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

    • versionNumber

      public final Long versionNumber()

      The version of the job execution. Job execution versions are incremented each time they are updated by a device.

      Returns:
      The version of the job execution. Job execution versions are incremented each time they are updated by a device.

    • executionNumber

      public final Long executionNumber()

      A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

      Returns:
      A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

    • jobDocument

      public final String jobDocument()

      The content of the job document.

      Returns:
      The content of the job document.

    • toBuilder

      public JobExecution.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<JobExecution.Builder,JobExecution>
      Returns:
      a builder for type T

    • builder

      public static JobExecution.Builder builder()

    • serializableBuilderClass

      public static Class<? extends JobExecution.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.