software.amazon.awssdk.services.batch.model.TaskContainerOverrides 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.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The overrides that should be sent to a container.
*
*
* For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TaskContainerOverrides implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> COMMAND_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("command")
.getter(getter(TaskContainerOverrides::command))
.setter(setter(Builder::command))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("command").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ENVIRONMENT_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("environment")
.getter(getter(TaskContainerOverrides::environment))
.setter(setter(Builder::environment))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("environment").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(KeyValuePair::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(TaskContainerOverrides::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField> RESOURCE_REQUIREMENTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("resourceRequirements")
.getter(getter(TaskContainerOverrides::resourceRequirements))
.setter(setter(Builder::resourceRequirements))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("resourceRequirements").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ResourceRequirement::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(COMMAND_FIELD,
ENVIRONMENT_FIELD, NAME_FIELD, RESOURCE_REQUIREMENTS_FIELD));
private static final long serialVersionUID = 1L;
private final List command;
private final List environment;
private final String name;
private final List resourceRequirements;
private TaskContainerOverrides(BuilderImpl builder) {
this.command = builder.command;
this.environment = builder.environment;
this.name = builder.name;
this.resourceRequirements = builder.resourceRequirements;
}
/**
* For responses, this returns true if the service returned a value for the Command property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasCommand() {
return command != null && !(command instanceof SdkAutoConstructList);
}
/**
*
* The command to send to the container that overrides the default command from the Docker image or the job
* definition.
*
*
*
* This parameter can't contain an empty string.
*
*
*
* 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 {@link #hasCommand} method.
*
*
* @return The command to send to the container that overrides the default command from the Docker image or the job
* definition.
*
* This parameter can't contain an empty string.
*
*/
public final List command() {
return command;
}
/**
* For responses, this returns true if the service returned a value for the Environment property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasEnvironment() {
return environment != null && !(environment instanceof SdkAutoConstructList);
}
/**
*
* The environment variables to send to the container. You can add new environment variables, which are added to the
* container at launch, or you can override the existing environment variables from the Docker image or the job
* definition.
*
*
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for variables
* that Batch sets.
*
*
*
* 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 {@link #hasEnvironment} method.
*
*
* @return The environment variables to send to the container. You can add new environment variables, which are
* added to the container at launch, or you can override the existing environment variables from the Docker
* image or the job definition.
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
*/
public final List environment() {
return environment;
}
/**
*
* A pointer to the container that you want to override. The container's name provides a unique identifier for the
* container being used.
*
*
* @return A pointer to the container that you want to override. The container's name provides a unique identifier
* for the container being used.
*/
public final String name() {
return name;
}
/**
* For responses, this returns true if the service returned a value for the ResourceRequirements property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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.
*/
public final boolean hasResourceRequirements() {
return resourceRequirements != null && !(resourceRequirements instanceof SdkAutoConstructList);
}
/**
*
* The type and amount of resources to assign to a container. This overrides the settings in the job definition. The
* supported resources include GPU, MEMORY, and VCPU.
*
*
* 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 {@link #hasResourceRequirements} method.
*
*
* @return The type and amount of resources to assign to a container. This overrides the settings in the job
* definition. The supported resources include GPU, MEMORY, and VCPU.
*/
public final List resourceRequirements() {
return resourceRequirements;
}
@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(hasCommand() ? command() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasEnvironment() ? environment() : null);
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasResourceRequirements() ? resourceRequirements() : null);
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 TaskContainerOverrides)) {
return false;
}
TaskContainerOverrides other = (TaskContainerOverrides) obj;
return hasCommand() == other.hasCommand() && Objects.equals(command(), other.command())
&& hasEnvironment() == other.hasEnvironment() && Objects.equals(environment(), other.environment())
&& Objects.equals(name(), other.name()) && hasResourceRequirements() == other.hasResourceRequirements()
&& Objects.equals(resourceRequirements(), other.resourceRequirements());
}
/**
* 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("TaskContainerOverrides").add("Command", hasCommand() ? command() : null)
.add("Environment", hasEnvironment() ? environment() : null).add("Name", name())
.add("ResourceRequirements", hasResourceRequirements() ? resourceRequirements() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "command":
return Optional.ofNullable(clazz.cast(command()));
case "environment":
return Optional.ofNullable(clazz.cast(environment()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "resourceRequirements":
return Optional.ofNullable(clazz.cast(resourceRequirements()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TaskContainerOverrides) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The command to send to the container that overrides the default command from the Docker image or the job
* definition.
*
*
*
* This parameter can't contain an empty string.
*
*
*
* @param command
* The command to send to the container that overrides the default command from the Docker image or the
* job definition.
*
* This parameter can't contain an empty string.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder command(Collection command);
/**
*
* The command to send to the container that overrides the default command from the Docker image or the job
* definition.
*
*
*
* This parameter can't contain an empty string.
*
*
*
* @param command
* The command to send to the container that overrides the default command from the Docker image or the
* job definition.
*
* This parameter can't contain an empty string.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder command(String... command);
/**
*
* The environment variables to send to the container. You can add new environment variables, which are added to
* the container at launch, or you can override the existing environment variables from the Docker image or the
* job definition.
*
*
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
*
*
* @param environment
* The environment variables to send to the container. You can add new environment variables, which are
* added to the container at launch, or you can override the existing environment variables from the
* Docker image or the job definition.
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environment(Collection environment);
/**
*
* The environment variables to send to the container. You can add new environment variables, which are added to
* the container at launch, or you can override the existing environment variables from the Docker image or the
* job definition.
*
*
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
*
*
* @param environment
* The environment variables to send to the container. You can add new environment variables, which are
* added to the container at launch, or you can override the existing environment variables from the
* Docker image or the job definition.
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environment(KeyValuePair... environment);
/**
*
* The environment variables to send to the container. You can add new environment variables, which are added to
* the container at launch, or you can override the existing environment variables from the Docker image or the
* job definition.
*
*
*
* Environment variables cannot start with AWS_BATCH. This naming convention is reserved for
* variables that Batch sets.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.batch.model.KeyValuePair.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.batch.model.KeyValuePair#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.batch.model.KeyValuePair.Builder#build()} is called immediately and
* its result is passed to {@link #environment(List)}.
*
* @param environment
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.batch.model.KeyValuePair.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #environment(java.util.Collection)
*/
Builder environment(Consumer... environment);
/**
*
* A pointer to the container that you want to override. The container's name provides a unique identifier for
* the container being used.
*
*
* @param name
* A pointer to the container that you want to override. The container's name provides a unique
* identifier for the container being used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The type and amount of resources to assign to a container. This overrides the settings in the job definition.
* The supported resources include GPU, MEMORY, and VCPU.
*
*
* @param resourceRequirements
* The type and amount of resources to assign to a container. This overrides the settings in the job
* definition. The supported resources include GPU, MEMORY, and
* VCPU.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceRequirements(Collection resourceRequirements);
/**
*
* The type and amount of resources to assign to a container. This overrides the settings in the job definition.
* The supported resources include GPU, MEMORY, and VCPU.
*
*
* @param resourceRequirements
* The type and amount of resources to assign to a container. This overrides the settings in the job
* definition. The supported resources include GPU, MEMORY, and
* VCPU.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resourceRequirements(ResourceRequirement... resourceRequirements);
/**
*
* The type and amount of resources to assign to a container. This overrides the settings in the job definition.
* The supported resources include GPU, MEMORY, and VCPU.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.batch.model.ResourceRequirement.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.batch.model.ResourceRequirement#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.batch.model.ResourceRequirement.Builder#build()} is called immediately
* and its result is passed to {@link #resourceRequirements(List)}.
*
* @param resourceRequirements
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.batch.model.ResourceRequirement.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #resourceRequirements(java.util.Collection)
*/
Builder resourceRequirements(Consumer... resourceRequirements);
}
static final class BuilderImpl implements Builder {
private List command = DefaultSdkAutoConstructList.getInstance();
private List environment = DefaultSdkAutoConstructList.getInstance();
private String name;
private List resourceRequirements = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(TaskContainerOverrides model) {
command(model.command);
environment(model.environment);
name(model.name);
resourceRequirements(model.resourceRequirements);
}
public final Collection getCommand() {
if (command instanceof SdkAutoConstructList) {
return null;
}
return command;
}
public final void setCommand(Collection command) {
this.command = StringListCopier.copy(command);
}
@Override
public final Builder command(Collection command) {
this.command = StringListCopier.copy(command);
return this;
}
@Override
@SafeVarargs
public final Builder command(String... command) {
command(Arrays.asList(command));
return this;
}
public final List getEnvironment() {
List result = EnvironmentVariablesCopier.copyToBuilder(this.environment);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEnvironment(Collection environment) {
this.environment = EnvironmentVariablesCopier.copyFromBuilder(environment);
}
@Override
public final Builder environment(Collection environment) {
this.environment = EnvironmentVariablesCopier.copy(environment);
return this;
}
@Override
@SafeVarargs
public final Builder environment(KeyValuePair... environment) {
environment(Arrays.asList(environment));
return this;
}
@Override
@SafeVarargs
public final Builder environment(Consumer... environment) {
environment(Stream.of(environment).map(c -> KeyValuePair.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final List getResourceRequirements() {
List result = ResourceRequirementsCopier.copyToBuilder(this.resourceRequirements);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setResourceRequirements(Collection resourceRequirements) {
this.resourceRequirements = ResourceRequirementsCopier.copyFromBuilder(resourceRequirements);
}
@Override
public final Builder resourceRequirements(Collection resourceRequirements) {
this.resourceRequirements = ResourceRequirementsCopier.copy(resourceRequirements);
return this;
}
@Override
@SafeVarargs
public final Builder resourceRequirements(ResourceRequirement... resourceRequirements) {
resourceRequirements(Arrays.asList(resourceRequirements));
return this;
}
@Override
@SafeVarargs
public final Builder resourceRequirements(Consumer... resourceRequirements) {
resourceRequirements(Stream.of(resourceRequirements).map(c -> ResourceRequirement.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public TaskContainerOverrides build() {
return new TaskContainerOverrides(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}