software.amazon.awssdk.services.batch.model.NodeRangeProperty Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of batch Show documentation
Show all versions of batch Show documentation
The AWS Java SDK for AWS Batch module holds the client classes that are used for communicating with AWS
Batch.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.batch.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An object representing the properties of the node range for a multi-node parallel job.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class NodeRangeProperty implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TARGET_NODES_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("targetNodes").getter(getter(NodeRangeProperty::targetNodes)).setter(setter(Builder::targetNodes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("targetNodes").build()).build();
private static final SdkField CONTAINER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("container")
.getter(getter(NodeRangeProperty::container)).setter(setter(Builder::container))
.constructor(ContainerProperties::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("container").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TARGET_NODES_FIELD,
CONTAINER_FIELD));
private static final long serialVersionUID = 1L;
private final String targetNodes;
private final ContainerProperties container;
private NodeRangeProperty(BuilderImpl builder) {
this.targetNodes = builder.targetNodes;
this.container = builder.container;
}
/**
*
* 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 which case
* the 4:5 range properties override the 0:10 properties.
*
*
* @return 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 which case the 4:5 range properties override the 0:10
* properties.
*/
public final String targetNodes() {
return targetNodes;
}
/**
*
* The container details for the node range.
*
*
* @return The container details for the node range.
*/
public final ContainerProperties container() {
return container;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(targetNodes());
hashCode = 31 * hashCode + Objects.hashCode(container());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof NodeRangeProperty)) {
return false;
}
NodeRangeProperty other = (NodeRangeProperty) obj;
return Objects.equals(targetNodes(), other.targetNodes()) && Objects.equals(container(), other.container());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("NodeRangeProperty").add("TargetNodes", targetNodes()).add("Container", container()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "targetNodes":
return Optional.ofNullable(clazz.cast(targetNodes()));
case "container":
return Optional.ofNullable(clazz.cast(container()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((NodeRangeProperty) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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
* which case the 4:5 range properties override the 0:10 properties.
*
*
* @param 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 which case the 4:5 range properties override
* the 0:10 properties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder targetNodes(String targetNodes);
/**
*
* The container details for the node range.
*
*
* @param container
* The container details for the node range.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder container(ContainerProperties container);
/**
*
* The container details for the node range.
*
* This is a convenience that creates an instance of the {@link ContainerProperties.Builder} avoiding the need
* to create one manually via {@link ContainerProperties#builder()}.
*
* When the {@link Consumer} completes, {@link ContainerProperties.Builder#build()} is called immediately and
* its result is passed to {@link #container(ContainerProperties)}.
*
* @param container
* a consumer that will call methods on {@link ContainerProperties.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #container(ContainerProperties)
*/
default Builder container(Consumer container) {
return container(ContainerProperties.builder().applyMutation(container).build());
}
}
static final class BuilderImpl implements Builder {
private String targetNodes;
private ContainerProperties container;
private BuilderImpl() {
}
private BuilderImpl(NodeRangeProperty model) {
targetNodes(model.targetNodes);
container(model.container);
}
public final String getTargetNodes() {
return targetNodes;
}
@Override
public final Builder targetNodes(String targetNodes) {
this.targetNodes = targetNodes;
return this;
}
public final void setTargetNodes(String targetNodes) {
this.targetNodes = targetNodes;
}
public final ContainerProperties.Builder getContainer() {
return container != null ? container.toBuilder() : null;
}
@Override
public final Builder container(ContainerProperties container) {
this.container = container;
return this;
}
public final void setContainer(ContainerProperties.BuilderImpl container) {
this.container = container != null ? container.build() : null;
}
@Override
public NodeRangeProperty build() {
return new NodeRangeProperty(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}