software.amazon.awssdk.services.batch.model.ComputeEnvironmentOrder Maven / Gradle / Ivy
Show all versions of batch Show documentation
/*
* 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.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;
/**
*
* The order that compute environments are tried in for job placement within a queue. Compute environments are tried in
* ascending order. For example, if two compute environments are associated with a job queue, the compute environment
* with a lower order integer value is tried for job placement first. Compute environments must be in the
* VALID
state before you can associate them with a job queue. All of the compute environments must be
* either EC2 (EC2
or SPOT
) or Fargate (FARGATE
or FARGATE_SPOT
);
* Amazon EC2 and Fargate compute environments can't be mixed.
*
*
*
* All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support
* mixing compute environment architecture types in a single job queue.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ComputeEnvironmentOrder implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ORDER_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("order")
.getter(getter(ComputeEnvironmentOrder::order)).setter(setter(Builder::order))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("order").build()).build();
private static final SdkField COMPUTE_ENVIRONMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("computeEnvironment").getter(getter(ComputeEnvironmentOrder::computeEnvironment))
.setter(setter(Builder::computeEnvironment))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("computeEnvironment").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ORDER_FIELD,
COMPUTE_ENVIRONMENT_FIELD));
private static final long serialVersionUID = 1L;
private final Integer order;
private final String computeEnvironment;
private ComputeEnvironmentOrder(BuilderImpl builder) {
this.order = builder.order;
this.computeEnvironment = builder.computeEnvironment;
}
/**
*
* The order of the compute environment. Compute environments are tried in ascending order. For example, if two
* compute environments are associated with a job queue, the compute environment with a lower order
* integer value is tried for job placement first.
*
*
* @return The order of the compute environment. Compute environments are tried in ascending order. For example, if
* two compute environments are associated with a job queue, the compute environment with a lower
* order
integer value is tried for job placement first.
*/
public final Integer order() {
return order;
}
/**
*
* The Amazon Resource Name (ARN) of the compute environment.
*
*
* @return The Amazon Resource Name (ARN) of the compute environment.
*/
public final String computeEnvironment() {
return computeEnvironment;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(order());
hashCode = 31 * hashCode + Objects.hashCode(computeEnvironment());
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 ComputeEnvironmentOrder)) {
return false;
}
ComputeEnvironmentOrder other = (ComputeEnvironmentOrder) obj;
return Objects.equals(order(), other.order()) && Objects.equals(computeEnvironment(), other.computeEnvironment());
}
/**
* 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("ComputeEnvironmentOrder").add("Order", order()).add("ComputeEnvironment", computeEnvironment())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "order":
return Optional.ofNullable(clazz.cast(order()));
case "computeEnvironment":
return Optional.ofNullable(clazz.cast(computeEnvironment()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function