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(value="software.amazon.awssdk:codegen")
public final class NodeProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NodeProperties.Builder,NodeProperties>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NodeProperties.Builder

Method Summary

Modifier and Type	Method and Description
static NodeProperties.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodeRangeProperties() Returns true if the NodeRangeProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 associated with a multi-node parallel job.
Integer	numNodes() The number of nodes associated with a multi-node parallel job.
List<SdkField<?>>	sdkFields()
static Class<? extends NodeProperties.Builder>	serializableBuilderClass()
NodeProperties.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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 associated with a multi-node parallel job.

Returns:

The number of nodes 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()

Returns true if the NodeRangeProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

nodeRangeProperties

public final List<NodeRangeProperty> nodeRangeProperties()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasNodeRangeProperties() to see if a value was sent in this field.

Returns:

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

toBuilder

public NodeProperties.Builder 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 interface ToCopyableBuilder<NodeProperties.Builder,NodeProperties>

Returns:

a builder for type T

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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.