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

Class NodeProperties

java.lang.Object

software.amazon.awssdk.services.batch.model.NodeProperties

All Implemented Interfaces:

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

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

An object that represents the node properties of a multi-node parallel job.

Node properties can't be specified for Amazon EKS based job definitions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeProperties.Builder

Method Summary

Modifier and Type	Method	Description
static NodeProperties.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodeRangeProperties()	For responses, this returns true if the service returned a value for the NodeRangeProperties property.
Integer	mainNode()	Specifies the node index for the main node of a multi-node parallel job.
List<NodeRangeProperty>	nodeRangeProperties()	A list of node ranges and their properties that are associated with a multi-node parallel job.
Integer	numNodes()	The number of nodes that are associated with a multi-node parallel job.
List<SdkField<?>>	sdkFields()
static Class<? extends NodeProperties.Builder>	serializableBuilderClass()
NodeProperties.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 that are associated with a multi-node parallel job.

Returns:

The number of nodes that are associated with a multi-node parallel job.

mainNode

public final Integer mainNode()

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

Returns:

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

hasNodeRangeProperties

public final boolean hasNodeRangeProperties()

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

nodeRangeProperties

public final List<NodeRangeProperty> nodeRangeProperties()

A list of node ranges and their properties that are associated with a multi-node parallel 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 hasNodeRangeProperties() method.

Returns:

A list of node ranges and their properties that are associated with a multi-node parallel job.

toBuilder

public NodeProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeProperties.Builder,NodeProperties>

builder

public static NodeProperties.Builder builder()

serializableBuilderClass

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