software.amazon.awssdk.services.batch.model

Class RegisterJobDefinitionRequest

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.RegisterJobDefinitionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterJobDefinitionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RegisterJobDefinitionRequest.Builder	builder()
ContainerProperties	containerProperties() An object with various properties specific to single-node container-based jobs.
boolean	equals(Object obj)
<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	jobDefinitionName() The name of the job definition to register.
NodeProperties	nodeProperties() An object with various properties specific to multi-node parallel jobs.
Map<String,String>	parameters() Default parameter substitution placeholders to set in the job definition.
RetryStrategy	retryStrategy() The retry strategy to use for failed jobs that are submitted with this job definition.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterJobDefinitionRequest.Builder>	serializableBuilderClass()
JobTimeout	timeout() The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished.
RegisterJobDefinitionRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
JobDefinitionType	type() The type of job definition.
String	typeAsString() The type of job definition.

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

jobDefinitionName

public String jobDefinitionName()

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

Returns:

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

type

public JobDefinitionType type()

The type of job definition.

If the service returns an enum value that is not available in the current SDK version, type will return JobDefinitionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of job definition.

See Also:

JobDefinitionType

typeAsString

public String typeAsString()

The type of job definition.

If the service returns an enum value that is not available in the current SDK version, type will return JobDefinitionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of job definition.

See Also:

JobDefinitionType

parameters

public Map<String,String> parameters()

Default parameter substitution placeholders to 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.

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

Returns:

Default parameter substitution placeholders to 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.

containerProperties

public ContainerProperties containerProperties()

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Returns:

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

nodeProperties

public NodeProperties nodeProperties()

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

Returns:

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

retryStrategy

public RetryStrategy retryStrategy()

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

Returns:

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

timeout

public JobTimeout timeout()

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Returns:

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

toBuilder

public RegisterJobDefinitionRequest.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<RegisterJobDefinitionRequest.Builder,RegisterJobDefinitionRequest>

Specified by:

toBuilder in class BatchRequest

Returns:

a builder for type T

builder

public static RegisterJobDefinitionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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