ContainerOverrides (AWS Java SDK :: Services

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ContainerOverrides.Builder,ContainerOverrides>

@Generated(value="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.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ContainerOverrides.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()` Returns true if the Command property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasEnvironment()` Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasResourceRequirements()` Returns true if the ResourceRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceType()` The instance type to use for a multi-node parallel job.
`Integer`	`memory()` The number of MiB of memory reserved for the job.
`List<ResourceRequirement>`	`resourceRequirements()` The type and amount of a resource 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()` The number of vCPUs to reserve for the container.

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
```
public Integer vcpus()
```
    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.
  - memory
```
public Integer memory()
```
    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.
  - hasCommand
```
public boolean hasCommand()
```
    Returns true if the Command property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - command
```
public List<String> command()
```
    The command to send to the container that overrides the default command from the Docker image or the job definition.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCommand() to see if a value was sent in this field.
    
    Returns:
    
    The command to send to the container that overrides the default command from the Docker image or the job definition.
  - instanceType
```
public String instanceType()
```
    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.
  - hasEnvironment
```
public boolean hasEnvironment()
```
    Returns true if the Environment property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - environment
```
public 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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasEnvironment() to see if a value was sent in this field.
    
    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.
  - hasResourceRequirements
```
public boolean hasResourceRequirements()
```
    Returns true if the ResourceRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - resourceRequirements
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasResourceRequirements() to see if a value was sent in this field.
    
    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.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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