com.amazonaws.services.batch.model

Class ContainerOverrides

java.lang.Object

com.amazonaws.services.batch.model.ContainerOverrides

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ContainerOverrides
extends Object
implements Serializable, Cloneable, StructuredPojo

The overrides that should be sent to a container.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContainerOverrides()

Method Summary

Modifier and Type	Method and Description
ContainerOverrides	clone()
boolean	equals(Object obj)
List<String>	getCommand() The command to send to the container that overrides the default command from the Docker image or the job definition.
List<KeyValuePair>	getEnvironment() The environment variables to send to the container.
String	getInstanceType() The instance type to use for a multi-node parallel job.
Integer	getMemory() Deprecated.
List<ResourceRequirement>	getResourceRequirements() The type and amount of resources to assign to a container.
Integer	getVcpus() Deprecated.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCommand(Collection<String> command) The command to send to the container that overrides the default command from the Docker image or the job definition.
void	setEnvironment(Collection<KeyValuePair> environment) The environment variables to send to the container.
void	setInstanceType(String instanceType) The instance type to use for a multi-node parallel job.
void	setMemory(Integer memory) Deprecated.
void	setResourceRequirements(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.
void	setVcpus(Integer vcpus) Deprecated.
String	toString() Returns a string representation of this object.
ContainerOverrides	withCommand(Collection<String> command) The command to send to the container that overrides the default command from the Docker image or the job definition.
ContainerOverrides	withCommand(String... command) The command to send to the container that overrides the default command from the Docker image or the job definition.
ContainerOverrides	withEnvironment(Collection<KeyValuePair> environment) The environment variables to send to the container.
ContainerOverrides	withEnvironment(KeyValuePair... environment) The environment variables to send to the container.
ContainerOverrides	withInstanceType(String instanceType) The instance type to use for a multi-node parallel job.
ContainerOverrides	withMemory(Integer memory) Deprecated.
ContainerOverrides	withResourceRequirements(Collection<ResourceRequirement> resourceRequirements) The type and amount of resources to assign to a container.
ContainerOverrides	withResourceRequirements(ResourceRequirement... resourceRequirements) The type and amount of resources to assign to a container.
ContainerOverrides	withVcpus(Integer vcpus) Deprecated.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerOverrides

public ContainerOverrides()

Method Detail

setVcpus

@Deprecated
public void setVcpus(Integer vcpus)

Deprecated.

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Parameters:

vcpus - This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

getVcpus

@Deprecated
public Integer getVcpus()

Deprecated.

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Returns:

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

withVcpus

@Deprecated
public ContainerOverrides withVcpus(Integer vcpus)

Deprecated.

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Parameters:

vcpus - This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirement structure in the job definition. To override vCPU requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to VCPU and value set to the new value.

This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources, you can use either this parameter or resourceRequirement but not both.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMemory

@Deprecated
public void setMemory(Integer memory)

Deprecated.

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Parameters:

memory - This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

getMemory

@Deprecated
public Integer getMemory()

Deprecated.

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Returns:

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

withMemory

@Deprecated
public ContainerOverrides withMemory(Integer memory)

Deprecated.

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Parameters:

memory - This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the memory parameter set in the job definition, but doesn't override any memory requirement specified in the ResourceRequirement structure in the job definition. To override memory requirements that are specified in the ResourceRequirement structure in the job definition, ResourceRequirement must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value.

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use resourceRequirement instead.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCommand

public List<String> getCommand()

The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

The command to send to the container that overrides the default command from the Docker image or the job definition.

setCommand

public void setCommand(Collection<String> command)

The command to send to the container that overrides the default command from the Docker image or the job definition.

Parameters:

command - The command to send to the container that overrides the default command from the Docker image or the job definition.

withCommand

public ContainerOverrides withCommand(String... command)

The command to send to the container that overrides the default command from the Docker image or the job definition.

NOTE: This method appends the values to the existing list (if any). Use setCommand(java.util.Collection) or withCommand(java.util.Collection) if you want to override the existing values.

Parameters:

command - The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCommand

public ContainerOverrides withCommand(Collection<String> command)

The command to send to the container that overrides the default command from the Docker image or the job definition.

Parameters:

command - The command to send to the container that overrides the default command from the Docker image or the job definition.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceType

public void setInstanceType(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.

Parameters:

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.

getInstanceType

public String getInstanceType()

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.

withInstanceType

public ContainerOverrides withInstanceType(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getEnvironment

public List<KeyValuePair> getEnvironment()

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

setEnvironment

public void setEnvironment(Collection<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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

Parameters:

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

withEnvironment

public ContainerOverrides withEnvironment(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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

NOTE: This method appends the values to the existing list (if any). Use setEnvironment(java.util.Collection) or withEnvironment(java.util.Collection) if you want to override the existing values.

Parameters:

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

Returns:

Returns a reference to this object so that method calls can be chained together.

withEnvironment

public ContainerOverrides withEnvironment(Collection<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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

Parameters:

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the Batch service.

Returns:

Returns a reference to this object so that method calls can be chained together.

getResourceRequirements

public List<ResourceRequirement> getResourceRequirements()

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.

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.

setResourceRequirements

public void setResourceRequirements(Collection<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.

Parameters:

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.

withResourceRequirements

public ContainerOverrides withResourceRequirements(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.

NOTE: This method appends the values to the existing list (if any). Use setResourceRequirements(java.util.Collection) or withResourceRequirements(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withResourceRequirements

public ContainerOverrides withResourceRequirements(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ContainerOverrides clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo