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(value="software.amazon.awssdk:codegen")
public final class StartNextPendingJobExecutionRequest
extends IotJobsDataPlaneRequest
implements ToCopyableBuilder<StartNextPendingJobExecutionRequest.Builder,StartNextPendingJobExecutionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartNextPendingJobExecutionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartNextPendingJobExecutionRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasStatusDetails() Returns true if the StatusDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the StatusDetails 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.

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.

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

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()

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<StartNextPendingJobExecutionRequest.Builder,StartNextPendingJobExecutionRequest>

Specified by:

toBuilder in class IotJobsDataPlaneRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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