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 milliseconds since the epoch, when the job completed.
Instant	createdAt() The time, in milliseconds since the epoch, when the job was created.
boolean	equals(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 milliseconds 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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

jobArn

public String jobArn()

The job ARN.

Returns:

The job ARN.

jobId

public 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 String thingGroupId()

The ID of the thing group.

Returns:

The ID of the thing group.

targetSelection

public 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 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 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 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 Instant createdAt()

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

Returns:

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

lastUpdatedAt

public Instant lastUpdatedAt()

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

Returns:

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

completedAt

public Instant completedAt()

The time, in milliseconds since the epoch, when the job completed.

Returns:

The time, in milliseconds since the epoch, when the job completed.

toBuilder

public JobSummary.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<JobSummary.Builder,JobSummary>

Returns:

a builder for type T

builder

public static JobSummary.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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