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

Class NodeRangeProperty

java.lang.Object

software.amazon.awssdk.services.batch.model.NodeRangeProperty

All Implemented Interfaces:

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

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

This is an object that represents the properties of the node range for a multi-node parallel job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeRangeProperty.Builder

Method Summary

Modifier and Type	Method	Description
static NodeRangeProperty.Builder	builder()
ContainerProperties	container()	The container details for the node range.
EcsProperties	ecsProperties()	This is an object that represents the properties of the node range for a multi-node parallel job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceTypes()	For responses, this returns true if the service returned a value for the InstanceTypes property.
List<String>	instanceTypes()	The instance types of the underlying host infrastructure of a multi-node parallel job.
List<SdkField<?>>	sdkFields()
static Class<? extends NodeRangeProperty.Builder>	serializableBuilderClass()
String	targetNodes()	The range of nodes, using node index values.
NodeRangeProperty.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

targetNodes

public final String targetNodes()

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes ( 0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

Returns:

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n ), then 0 is used to start the range. If the ending range value is omitted (n: ), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

container

public final ContainerProperties container()

The container details for the node range.

Returns:

The container details for the node range.

hasInstanceTypes

public final boolean hasInstanceTypes()

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

instanceTypes

public final List<String> instanceTypes()

The instance types of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

In addition, this list object is currently limited to one element.

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

Returns:

The instance types of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

In addition, this list object is currently limited to one element.

ecsProperties

public final EcsProperties ecsProperties()

This is an object that represents the properties of the node range for a multi-node parallel job.

Returns:

This is an object that represents the properties of the node range for a multi-node parallel job.

toBuilder

public NodeRangeProperty.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeRangeProperty.Builder,NodeRangeProperty>

builder

public static NodeRangeProperty.Builder builder()

serializableBuilderClass

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