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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CancelJobRequest.Builder

Method Summary

Modifier and Type	Method and 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 AWS Batch job ID of the job to cancel.
String	reason() A message to attach to the job that explains the reason for canceling it.
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 String jobId()

The AWS Batch job ID of the job to cancel.

Returns:

The AWS Batch job ID of the job to cancel.

reason

public 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. This message is also recorded in the AWS Batch activity logs.

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. This message is also recorded in the AWS Batch activity logs.

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

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo