java.lang.Object
- software.amazon.awssdk.services.batch.model.ContainerOverrides

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>
```
@Generated("software.amazon.awssdk:codegen")
public final class ContainerOverrides
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>
```
The overrides that should be sent to a container.

For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ContainerOverrides.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static ContainerOverrides.Builder`	`builder()`
`List<String>`	`command()`	The command to send to the container that overrides the default command from the Docker image or the job definition.
`List<KeyValuePair>`	`environment()`	The environment variables to send to the container.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCommand()`	For responses, this returns true if the service returned a value for the Command property.
`boolean`	`hasEnvironment()`	For responses, this returns true if the service returned a value for the Environment property.
`int`	`hashCode()`
`boolean`	`hasResourceRequirements()`	For responses, this returns true if the service returned a value for the ResourceRequirements property.
`String`	`instanceType()`	The instance type to use for a multi-node parallel job.
`Integer`	`memory()`	Deprecated. This field is deprecated, use resourceRequirements instead.
`List<ResourceRequirement>`	`resourceRequirements()`	The type and amount of resources to assign to a container.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ContainerOverrides.Builder>`	`serializableBuilderClass()`
`ContainerOverrides.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`vcpus()`	Deprecated. This field is deprecated, use resourceRequirements instead.

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
  - vcpus
```
@Deprecated
public final Integer vcpus()
```
    Deprecated.
    This field is deprecated, use resourceRequirements instead.
    
    This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
    
    Returns:
    
    This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
  - memory
```
@Deprecated
public final Integer memory()
```
    Deprecated.
    This field is deprecated, use resourceRequirements instead.
    
    This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
    
    Returns:
    
    This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.
  - hasCommand
```
public final boolean hasCommand()
```
    For responses, this returns true if the service returned a value for the Command 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.
  - command
```
public final List<String> command()
```
    The command to send to the container that overrides the default command from the Docker image or the job definition.
    
    This parameter can't contain an empty string.
    
    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 hasCommand() method.
    
    Returns:
    
    The command to send to the container that overrides the default command from the Docker image or the job definition.
    
    This parameter can't contain an empty string.
  - instanceType
```
public final String instanceType()
```
    The instance type to use for a multi-node parallel job.
    
    This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
    
    Returns:
    
    The instance type to use for a multi-node parallel job.
    
    This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
  - hasEnvironment
```
public final boolean hasEnvironment()
```
    For responses, this returns true if the service returned a value for the Environment 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.
  - environment
```
public final List<KeyValuePair> environment()
```
    The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
    
    Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.
    
    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 hasEnvironment() method.
    
    Returns:
    
    The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.
    
    Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.
  - hasResourceRequirements
```
public final boolean hasResourceRequirements()
```
    For responses, this returns true if the service returned a value for the ResourceRequirements 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.
  - resourceRequirements
```
public final List<ResourceRequirement> resourceRequirements()
```
    The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
    
    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 hasResourceRequirements() method.
    
    Returns:
    
    The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
  - toBuilder
```
public ContainerOverrides.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>
  - builder
```
public static ContainerOverrides.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ContainerOverrides.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 ContainerOverrides

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

vcpus

memory

hasCommand

command

instanceType

hasEnvironment

environment

hasResourceRequirements

resourceRequirements

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields