software.amazon.awssdk.services.pipes.model

Class BatchContainerOverrides

java.lang.Object

software.amazon.awssdk.services.pipes.model.BatchContainerOverrides

All Implemented Interfaces:

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

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

The overrides that are sent to a container.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchContainerOverrides.Builder

Method Summary

Modifier and Type	Method and Description
static BatchContainerOverrides.Builder	builder()
List<String>	command() The command to send to the container that overrides the default command from the Docker image or the task definition.
List<BatchEnvironmentVariable>	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.
List<BatchResourceRequirement>	resourceRequirements() The type and amount of resources to assign to a container.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchContainerOverrides.Builder>	serializableBuilderClass()
BatchContainerOverrides.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

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 task 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 task definition.

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<BatchEnvironmentVariable> 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 task definition.

Environment variables cannot start with "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 task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

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.

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<BatchResourceRequirement> 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 BatchContainerOverrides.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchContainerOverrides.Builder,BatchContainerOverrides>

builder

public static BatchContainerOverrides.Builder builder()

serializableBuilderClass

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