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

Class StartNextPendingJobExecutionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotjobsdataplane.model.IotJobsDataPlaneRequest

software.amazon.awssdk.services.iotjobsdataplane.model.StartNextPendingJobExecutionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartNextPendingJobExecutionRequest.Builder,StartNextPendingJobExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartNextPendingJobExecutionRequest
extends IotJobsDataPlaneRequest
implements ToCopyableBuilder<StartNextPendingJobExecutionRequest.Builder,StartNextPendingJobExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartNextPendingJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartNextPendingJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStatusDetails()	For responses, this returns true if the service returned a value for the StatusDetails property.
List<SdkField<?>>	sdkFields()
static Class<? extends StartNextPendingJobExecutionRequest.Builder>	serializableBuilderClass()
Map<String,String>	statusDetails()	A collection of name/value pairs that describe the status of the job execution.
Long	stepTimeoutInMinutes()	Specifies the amount of time this device has to finish execution of this job.
String	thingName()	The name of the thing associated with the device.
StartNextPendingJobExecutionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

thingName

public final String thingName()

The name of the thing associated with the device.

Returns:

The name of the thing associated with the device.

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. If not specified, the statusDetails are unchanged.

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. If not specified, the statusDetails are unchanged.

stepTimeoutInMinutes

public final Long stepTimeoutInMinutes()

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

Returns:

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

toBuilder

public StartNextPendingJobExecutionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartNextPendingJobExecutionRequest.Builder,StartNextPendingJobExecutionRequest>

Specified by:

toBuilder in class IotJobsDataPlaneRequest

builder

public static StartNextPendingJobExecutionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo