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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
JobProcessDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static JobProcessDetails.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasProcessingTargets()
For responses, this returns true if the service returned a value for the ProcessingTargets property.Integer
numberOfCanceledThings()
The number of things that cancelled the job.Integer
numberOfFailedThings()
The number of things that failed executing the job.Integer
numberOfInProgressThings()
The number of things currently executing the job.Integer
numberOfQueuedThings()
The number of things that are awaiting execution of the job.Integer
numberOfRejectedThings()
The number of things that rejected the job.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.Integer
numberOfSucceededThings()
The number of things which successfully completed the job.Integer
numberOfTimedOutThings()
The number of things whose job execution status isTIMED_OUT
.List<String>
processingTargets()
The target devices to which the job execution is being rolled out.List<SdkField<?>>
sdkFields()
static Class<? extends JobProcessDetails.Builder>
serializableBuilderClass()
JobProcessDetails.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>
-
builder
public static JobProcessDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends JobProcessDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-