software.amazon.awssdk.services.iot.model

Class JobProcessDetails

java.lang.Object

software.amazon.awssdk.services.iot.model.JobProcessDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>

@Generated(value="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 and Description
static interface	JobProcessDetails.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the ProcessingTargets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 is TIMED_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()

Returns true if the ProcessingTargets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasProcessingTargets() to see if a value was sent in this field.

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 interface ToCopyableBuilder<JobProcessDetails.Builder,JobProcessDetails>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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