software.amazon.awssdk.services.batch.model

Class JobDefinition

java.lang.Object

software.amazon.awssdk.services.batch.model.JobDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobDefinition.Builder,JobDefinition>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobDefinition.Builder,JobDefinition>

An object representing an AWS Batch job definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobDefinition.Builder

Method Summary

Modifier and Type	Method and Description
static JobDefinition.Builder	builder()
ContainerProperties	containerProperties() An object with various properties specific to container-based jobs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobDefinitionArn() The Amazon Resource Name (ARN) for the job definition.
String	jobDefinitionName() The name of the job definition.
NodeProperties	nodeProperties() An object with various properties specific to multi-node parallel jobs.
Map<String,String>	parameters() Default parameters or parameter substitution placeholders that are set in the job definition.
RetryStrategy	retryStrategy() The retry strategy to use for failed jobs that are submitted with this job definition.
Integer	revision() The revision of the job definition.
List<SdkField<?>>	sdkFields()
static Class<? extends JobDefinition.Builder>	serializableBuilderClass()
String	status() The status of the job definition.
JobTimeout	timeout() The timeout configuration for jobs that are submitted with this job definition.
JobDefinition.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of job definition.

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

jobDefinitionName

public String jobDefinitionName()

The name of the job definition.

Returns:

The name of the job definition.

jobDefinitionArn

public String jobDefinitionArn()

The Amazon Resource Name (ARN) for the job definition.

Returns:

The Amazon Resource Name (ARN) for the job definition.

revision

public Integer revision()

The revision of the job definition.

Returns:

The revision of the job definition.

status

public String status()

The status of the job definition.

Returns:

The status of the job definition.

type

public String type()

The type of job definition.

Returns:

The type of job definition.

parameters

public Map<String,String> parameters()

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.

retryStrategy

public RetryStrategy retryStrategy()

The retry strategy to use for failed jobs that are submitted with this job definition.

Returns:

The retry strategy to use for failed jobs that are submitted with this job definition.

containerProperties

public ContainerProperties containerProperties()

An object with various properties specific to container-based jobs.

Returns:

An object with various properties specific to container-based jobs.

timeout

public JobTimeout timeout()

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

Returns:

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

nodeProperties

public NodeProperties nodeProperties()

An object with various properties specific to multi-node parallel jobs.

Returns:

An object with various properties specific to multi-node parallel jobs.

toBuilder

public JobDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobDefinition.Builder,JobDefinition>

builder

public static JobDefinition.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo