Class EksContainerOverride
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EksContainerOverride.Builder,
EksContainerOverride>
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionargs()
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()
command()
The command to send to the container that overrides the default command from the Docker image or the job definition.env()
The environment variables to send to the container.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasArgs()
For responses, this returns true if the service returned a value for the Args property.final boolean
For responses, this returns true if the service returned a value for the Command property.final boolean
hasEnv()
For responses, this returns true if the service returned a value for the Env property.final int
hashCode()
final String
image()
The override of the Docker image that's used to start the container.final String
name()
A pointer to the container that you want to override.The type and amount of resources to assign to a container.static Class
<? extends EksContainerOverride.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A pointer to the container that you want to override. The name must match a unique container name that you wish to override.
- Returns:
- A pointer to the container that you want to override. The name must match a unique container name that you wish to override.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 Dockerfile reference: CMD 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 Dockerfile reference: CMD 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 theisEmpty()
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
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
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
, andnvidia.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
, andnvidia.com/gpu
. For more information, see Resource management for pods and containers in the Kubernetes documentation.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EksContainerOverride.Builder,
EksContainerOverride> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-