JobDefinition (AWS Java SDK :: Services

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 that represents an Batch job definition.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JobDefinition.Builder`	`builder()`
`OrchestrationType`	`containerOrchestrationType()` The orchestration type of the compute environment.
`String`	`containerOrchestrationTypeAsString()` The orchestration type of the compute environment.
`ContainerProperties`	`containerProperties()` An object with various properties specific to Amazon ECS based jobs.
`EksProperties`	`eksProperties()` An object with various properties that are specific to Amazon EKS based jobs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasPlatformCapabilities()` For responses, this returns true if the service returned a value for the PlatformCapabilities property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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 that are specific to multi-node parallel jobs.
`Map<String,String>`	`parameters()` Default parameters or parameter substitution placeholders that are set in the job definition.
`List<PlatformCapability>`	`platformCapabilities()` The platform capabilities required by the job definition.
`List<String>`	`platformCapabilitiesAsStrings()` The platform capabilities required by the job definition.
`Boolean`	`propagateTags()` Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
`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.
`Integer`	`schedulingPriority()` The scheduling priority of the job definition.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobDefinition.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the job definition.
`Map<String,String>`	`tags()` The tags that are applied to the job definition.
`JobTimeout`	`timeout()` The timeout time 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 final String jobDefinitionName()
```
    The name of the job definition.
    
    Returns:
    
    The name of the job definition.
  - jobDefinitionArn
```
public final String jobDefinitionArn()
```
    The Amazon Resource Name (ARN) for the job definition.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the job definition.
  - revision
```
public final Integer revision()
```
    The revision of the job definition.
    
    Returns:
    
    The revision of the job definition.
  - status
```
public final String status()
```
    The status of the job definition.
    
    Returns:
    
    The status of the job definition.
  - type
```
public final String type()
```
    The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
    
    Returns:
    
    The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
  - schedulingPriority
```
public final Integer schedulingPriority()
```
    The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
    
    Returns:
    
    The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final 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 Batch User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    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 Batch User Guide.
  - retryStrategy
```
public final 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 final ContainerProperties containerProperties()
```
    An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
    
    Returns:
    
    An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
  - timeout
```
public final JobTimeout timeout()
```
    The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
    
    Returns:
    
    The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
  - nodeProperties
```
public final NodeProperties nodeProperties()
```
    An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
    
    If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.
    
    Returns:
    
    An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
    
    If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags that are applied to the job definition.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags that are applied to the job definition.
  - propagateTags
```
public final Boolean propagateTags()
```
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
    
    Returns:
    
    Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.
  - platformCapabilities
```
public final List<PlatformCapability> platformCapabilities()
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformCapabilities() method.
    
    Returns:
    
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
  - hasPlatformCapabilities
```
public final boolean hasPlatformCapabilities()
```
    For responses, this returns true if the service returned a value for the PlatformCapabilities property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - platformCapabilitiesAsStrings
```
public final List<String> platformCapabilitiesAsStrings()
```
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPlatformCapabilities() method.
    
    Returns:
    
    The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.
  - eksProperties
```
public final EksProperties eksProperties()
```
    An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
    
    Returns:
    
    An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
  - containerOrchestrationType
```
public final OrchestrationType containerOrchestrationType()
```
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    If the service returns an enum value that is not available in the current SDK version, containerOrchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerOrchestrationTypeAsString().
    
    Returns:
    
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    See Also:
    
    OrchestrationType
  - containerOrchestrationTypeAsString
```
public final String containerOrchestrationTypeAsString()
```
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    If the service returns an enum value that is not available in the current SDK version, containerOrchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerOrchestrationTypeAsString().
    
    Returns:
    
    The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
    
    See Also:
    
    OrchestrationType
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobDefinitionName

jobDefinitionArn

revision

status

type

schedulingPriority

hasParameters

parameters

retryStrategy

containerProperties

timeout

nodeProperties

hasTags

tags

propagateTags

platformCapabilities

hasPlatformCapabilities

platformCapabilitiesAsStrings

eksProperties

containerOrchestrationType

containerOrchestrationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields