Package software.amazon.awssdk.services.batch.model

Class NodeOverrides

java.lang.Object

software.amazon.awssdk.services.batch.model.NodeOverrides

All Implemented Interfaces:

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

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

An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs. Rather, use containerOverrides instead.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeOverrides.Builder

Method Summary

Modifier and Type	Method	Description
static NodeOverrides.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodePropertyOverrides()	For responses, this returns true if the service returned a value for the NodePropertyOverrides property.
List<NodePropertyOverride>	nodePropertyOverrides()	The node property overrides for the job.
Integer	numNodes()	The number of nodes to use with a multi-node parallel job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NodeOverrides.Builder>	serializableBuilderClass()
NodeOverrides.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

numNodes

public final Integer numNodes()

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

• There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.

• The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.

• The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

Returns:

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

• There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.

• The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.

• The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

hasNodePropertyOverrides

public final boolean hasNodePropertyOverrides()

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

nodePropertyOverrides

public final List<NodePropertyOverride> nodePropertyOverrides()

The node property overrides for the job.

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

Returns:

The node property overrides for the job.

toBuilder

public NodeOverrides.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeOverrides.Builder,NodeOverrides>

builder

public static NodeOverrides.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo