software.amazon.awssdk.services.batch.model

Class EksContainerOverride

java.lang.Object

software.amazon.awssdk.services.batch.model.EksContainerOverride

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EksContainerOverride.Builder,EksContainerOverride>

@Generated(value="software.amazon.awssdk:codegen")
public final class EksContainerOverride
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EksContainerOverride.Builder,EksContainerOverride>

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EksContainerOverride.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	args() The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition.
static EksContainerOverride.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<EksContainerEnvironmentVariable>	env() 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	hasArgs() For responses, this returns true if the service returned a value for the Args property.
boolean	hasCommand() For responses, this returns true if the service returned a value for the Command property.
boolean	hasEnv() For responses, this returns true if the service returned a value for the Env property.
int	hashCode()
String	image() The override of the Docker image that's used to start the container.
EksContainerResourceRequirements	resources() The type and amount of resources to assign to a container.
List<SdkField<?>>	sdkFields()
static Class<? extends EksContainerOverride.Builder>	serializableBuilderClass()
EksContainerOverride.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

image

public final String image()

The override of the Docker image that's used to start the container.

Returns:

The override of the Docker image that's used to start the container.

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.

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.

hasArgs

public final boolean hasArgs()

For responses, this returns true if the service returned a value for the Args 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.

args

public final List<String> args()

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

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 hasArgs() method.

Returns:

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see CMD in the Dockerfile reference and Define a command an arguments for a pod in the Kubernetes documentation.

hasEnv

public final boolean hasEnv()

For responses, this returns true if the service returned a value for the Env 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.

env

public final List<EksContainerEnvironmentVariable> env()

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

resources

public final EksContainerResourceRequirements resources()

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Returns:

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

toBuilder

public EksContainerOverride.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EksContainerOverride.Builder,EksContainerOverride>

builder

public static EksContainerOverride.Builder builder()

serializableBuilderClass

public static Class<? extends EksContainerOverride.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