Package software.amazon.awssdk.services.batch.model

Class CancelJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.batch.model.BatchRequest

software.amazon.awssdk.services.batch.model.CancelJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

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

Contains the parameters for CancelJob.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancelJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CancelJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The Batch job ID of the job to cancel.
String	reason()	A message to attach to the job that explains the reason for canceling it.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CancelJobRequest.Builder>	serializableBuilderClass()
CancelJobRequest.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

jobId

public final String jobId()

The Batch job ID of the job to cancel.

Returns:

The Batch job ID of the job to cancel.

reason

public final String reason()

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.

Returns:

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. It is also recorded in the Batch activity logs.

This parameter has as limit of 1024 characters.

toBuilder

public CancelJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancelJobRequest.Builder,CancelJobRequest>

Specified by:

toBuilder in class BatchRequest

builder

public static CancelJobRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo