@Generated(value="software.amazon.awssdk:codegen") public final class CancelJobRequest extends IotRequest implements ToCopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CancelJobRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CancelJobRequest.Builder |
builder() |
String |
comment()
An optional comment string describing why the job was canceled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Boolean |
force()
(Optional) If
true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise
only job executions with status "QUEUED" are canceled. |
<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() |
String |
jobId()
The unique identifier you assigned to this job when it was created.
|
String |
reasonCode()
(Optional)A reason code string that explains why the job was canceled.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CancelJobRequest.Builder> |
serializableBuilderClass() |
CancelJobRequest.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.
|
overrideConfiguration
copy
public final String jobId()
The unique identifier you assigned to this job when it was created.
public final String reasonCode()
(Optional)A reason code string that explains why the job was canceled.
public final String comment()
An optional comment string describing why the job was canceled.
public final Boolean force()
(Optional) If true
job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise
only job executions with status "QUEUED" are canceled. The default is false
.
Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
true
job executions with status "IN_PROGRESS" and "QUEUED" are canceled,
otherwise only job executions with status "QUEUED" are canceled. The default is false
.
Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
public CancelJobRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>
toBuilder
in class IotRequest
public static CancelJobRequest.Builder builder()
public static Class<? extends CancelJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.