software.amazon.awssdk.services.iot.model

Class JobSummary

java.lang.Object

software.amazon.awssdk.services.iot.model.JobSummary

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class JobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobSummary.Builder,JobSummary>

The job summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static JobSummary.Builder	builder()
Instant	completedAt() The time, in seconds since the epoch, when the job completed.
Instant	createdAt() The time, in seconds since the epoch, when the job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobArn() The job ARN.
String	jobId() The unique identifier you assigned to this job when it was created.
Instant	lastUpdatedAt() The time, in seconds since the epoch, when the job was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends JobSummary.Builder>	serializableBuilderClass()
JobStatus	status() The job summary status.
String	statusAsString() The job summary status.
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).
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).
String	thingGroupId() The ID of the thing group.
JobSummary.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

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.

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.

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.

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.

See Also:

TargetSelection

status

public final JobStatus status()

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

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.

toBuilder

public JobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobSummary.Builder,JobSummary>

builder

public static JobSummary.Builder builder()

serializableBuilderClass

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