ContainerOverrides (AWS Java SDK for AWS Batch 1.11.903 API)

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()

Constructors
Constructor and Description
`ContainerOverrides()`

Method Summary

All Methods Instance Methods Concrete Methods
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()` The number of MiB of memory reserved for the job.
`List<ResourceRequirement>`	`getResourceRequirements()` The type and amount of a resource to assign to a container.
`Integer`	`getVcpus()` The number of vCPUs to reserve for the container.
`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)` The number of MiB of memory reserved for the job.
`void`	`setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container.
`void`	`setVcpus(Integer vcpus)` The number of vCPUs to reserve for the container.
`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)` The number of MiB of memory reserved for the job.
`ContainerOverrides`	`withResourceRequirements(Collection<ResourceRequirement> resourceRequirements)` The type and amount of a resource to assign to a container.
`ContainerOverrides`	`withResourceRequirements(ResourceRequirement... resourceRequirements)` The type and amount of a resource to assign to a container.
`ContainerOverrides`	`withVcpus(Integer vcpus)` The number of vCPUs to reserve for the container.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ContainerOverrides
```
public ContainerOverrides()
```
- Method Detail
  - setVcpus
```
public void setVcpus(Integer vcpus)
```
    The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
    
    Parameters:
    
    vcpus - The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
  - getVcpus
```
public Integer getVcpus()
```
    The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
    
    Returns:
    
    The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
  - withVcpus
```
public ContainerOverrides withVcpus(Integer vcpus)
```
    The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
    
    Parameters:
    
    vcpus - The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMemory
```
public void setMemory(Integer memory)
```
    The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
    
    Parameters:
    
    memory - The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
  - getMemory
```
public Integer getMemory()
```
    The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
    
    Returns:
    
    The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
  - withMemory
```
public ContainerOverrides withMemory(Integer memory)
```
    The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
    
    Parameters:
    
    memory - The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
    
    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 is not valid for single-node container jobs.
    
    Parameters:
    
    instanceType - The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
  - getInstanceType
```
public String getInstanceType()
```
    The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
    
    Returns:
    
    The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
  - withInstanceType
```
public ContainerOverrides withInstanceType(String instanceType)
```
    The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
    
    Parameters:
    
    instanceType - The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
    
    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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    Returns:
    
    The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
  - setResourceRequirements
```
public void setResourceRequirements(Collection<ResourceRequirement> resourceRequirements)
```
    The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
  - withResourceRequirements
```
public ContainerOverrides withResourceRequirements(ResourceRequirement... resourceRequirements)
```
    The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    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 a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    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 a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    Parameters:
    
    resourceRequirements - The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
    
    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

Class ContainerOverrides

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContainerOverrides

Method Detail

setVcpus

getVcpus

withVcpus

setMemory

getMemory

withMemory

getCommand

setCommand

withCommand

withCommand

setInstanceType

getInstanceType

withInstanceType

getEnvironment

setEnvironment

withEnvironment

withEnvironment

getResourceRequirements

setResourceRequirements

withResourceRequirements

withResourceRequirements

toString

equals

hashCode

clone

marshall