software.amazon.awssdk.services.batch.model.LinuxParameters 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;
/**
*
* Linux-specific modifications that are applied to the container, such as details for device mappings.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class LinuxParameters implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> DEVICES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("devices")
.getter(getter(LinuxParameters::devices))
.setter(setter(Builder::devices))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("devices").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Device::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField INIT_PROCESS_ENABLED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("initProcessEnabled").getter(getter(LinuxParameters::initProcessEnabled))
.setter(setter(Builder::initProcessEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("initProcessEnabled").build())
.build();
private static final SdkField SHARED_MEMORY_SIZE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("sharedMemorySize").getter(getter(LinuxParameters::sharedMemorySize))
.setter(setter(Builder::sharedMemorySize))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("sharedMemorySize").build()).build();
private static final SdkField> TMPFS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tmpfs")
.getter(getter(LinuxParameters::tmpfs))
.setter(setter(Builder::tmpfs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tmpfs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tmpfs::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_SWAP_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxSwap").getter(getter(LinuxParameters::maxSwap)).setter(setter(Builder::maxSwap))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxSwap").build()).build();
private static final SdkField SWAPPINESS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("swappiness").getter(getter(LinuxParameters::swappiness)).setter(setter(Builder::swappiness))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("swappiness").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEVICES_FIELD,
INIT_PROCESS_ENABLED_FIELD, SHARED_MEMORY_SIZE_FIELD, TMPFS_FIELD, MAX_SWAP_FIELD, SWAPPINESS_FIELD));
private static final long serialVersionUID = 1L;
private final List devices;
private final Boolean initProcessEnabled;
private final Integer sharedMemorySize;
private final List tmpfs;
private final Integer maxSwap;
private final Integer swappiness;
private LinuxParameters(BuilderImpl builder) {
this.devices = builder.devices;
this.initProcessEnabled = builder.initProcessEnabled;
this.sharedMemorySize = builder.sharedMemorySize;
this.tmpfs = builder.tmpfs;
this.maxSwap = builder.maxSwap;
this.swappiness = builder.swappiness;
}
/**
* For responses, this returns true if the service returned a value for the Devices 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 hasDevices() {
return devices != null && !(devices instanceof SdkAutoConstructList);
}
/**
*
* Any of the host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
*
*
*
* 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 #hasDevices} method.
*
*
* @return Any of the host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the
* Docker Remote API and the --device
* option to docker run.
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
* jobs.
*
*/
public final List devices() {
return devices;
}
/**
*
* If true, run an init
process inside the container that forwards signals and reaps processes. This
* parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the
* Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container
* instance, log in to your container instance and run the following command:
* sudo docker version | grep "Server API version"
*
*
* @return If true, run an init
process inside the container that forwards signals and reaps processes.
* This parameter maps to the --init
option to docker run. This parameter requires version 1.25
* of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on
* your container instance, log in to your container instance and run the following command:
* sudo docker version | grep "Server API version"
*/
public final Boolean initProcessEnabled() {
return initProcessEnabled;
}
/**
*
* The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the
* --shm-size
option to docker run.
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
*
*
*
* @return The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the
* --shm-size
option to docker
* run.
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
* jobs.
*
*/
public final Integer sharedMemorySize() {
return sharedMemorySize;
}
/**
* For responses, this returns true if the service returned a value for the Tmpfs 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 hasTmpfs() {
return tmpfs != null && !(tmpfs instanceof SdkAutoConstructList);
}
/**
*
* The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps to the
* --tmpfs
option to docker run.
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for
* this resource type.
*
*
*
* 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 #hasTmpfs} method.
*
*
* @return The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps
* to the --tmpfs
option to docker
* run.
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this
* parameter for this resource type.
*
*/
public final List tmpfs() {
return tmpfs;
}
/**
*
* The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
* --memory-swap
option to docker run where
* the value is the sum of the container memory plus the maxSwap
value. For more information, see
* --memory-swap
details in the Docker documentation.
*
*
* If a maxSwap
value of 0
is specified, the container doesn't use swap. Accepted values
* are 0
or any positive integer. If the maxSwap
parameter is omitted, the container
* doesn't use the swap configuration for the container instance that it's running on. A maxSwap
value
* must be set for the swappiness
parameter to be used.
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
*
*
*
* @return The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
* --memory-swap
option to docker
* run where the value is the sum of the container memory plus the maxSwap
value. For more
* information, see
* --memory-swap
details in the Docker documentation.
*
* If a maxSwap
value of 0
is specified, the container doesn't use swap. Accepted
* values are 0
or any positive integer. If the maxSwap
parameter is omitted, the
* container doesn't use the swap configuration for the container instance that it's running on. A
* maxSwap
value must be set for the swappiness
parameter to be used.
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
* jobs.
*
*/
public final Integer maxSwap() {
return maxSwap;
}
/**
*
* You can use this parameter to tune a container's memory swappiness behavior. A swappiness
value of
* 0
causes swapping to not occur unless absolutely necessary. A swappiness
value of
* 100
causes pages to be swapped aggressively. Valid values are whole numbers between 0
* and 100
. If the swappiness
parameter isn't specified, a default value of
* 60
is used. If a value isn't specified for maxSwap
, then this parameter is ignored. If
* maxSwap
is set to 0, the container doesn't use swap. This parameter maps to the
* --memory-swappiness
option to docker
* run.
*
*
* Consider the following when you use a per-container swap configuration.
*
*
* -
*
* Swap space must be enabled and allocated on the container instance for the containers to use.
*
*
*
* By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use
* this feature. For more information, see Instance store swap
* volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to
* work as swap space in an Amazon EC2 instance by using a swap file?
*
*
* -
*
* The swap space parameters are only supported for job definitions using EC2 resources.
*
*
* -
*
* If the maxSwap
and swappiness
parameters are omitted from a job definition, each
* container has a default swappiness
value of 60. Moreover, the total swap usage is limited to two
* times the memory reservation of the container.
*
*
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
*
*
*
* @return You can use this parameter to tune a container's memory swappiness behavior. A swappiness
* value of 0
causes swapping to not occur unless absolutely necessary. A
* swappiness
value of 100
causes pages to be swapped aggressively. Valid values
* are whole numbers between 0
and 100
. If the swappiness
parameter
* isn't specified, a default value of 60
is used. If a value isn't specified for
* maxSwap
, then this parameter is ignored. If maxSwap
is set to 0, the container
* doesn't use swap. This parameter maps to the --memory-swappiness
option to docker run.
*
* Consider the following when you use a per-container swap configuration.
*
*
* -
*
* Swap space must be enabled and allocated on the container instance for the containers to use.
*
*
*
* By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance
* to use this feature. For more information, see Instance
* store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate
* memory to work as swap space in an Amazon EC2 instance by using a swap file?
*
*
* -
*
* The swap space parameters are only supported for job definitions using EC2 resources.
*
*
* -
*
* If the maxSwap
and swappiness
parameters are omitted from a job definition,
* each container has a default swappiness
value of 60. Moreover, the total swap usage is
* limited to two times the memory reservation of the container.
*
*
*
*
*
* This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
* jobs.
*
*/
public final Integer swappiness() {
return swappiness;
}
@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(hasDevices() ? devices() : null);
hashCode = 31 * hashCode + Objects.hashCode(initProcessEnabled());
hashCode = 31 * hashCode + Objects.hashCode(sharedMemorySize());
hashCode = 31 * hashCode + Objects.hashCode(hasTmpfs() ? tmpfs() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxSwap());
hashCode = 31 * hashCode + Objects.hashCode(swappiness());
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 LinuxParameters)) {
return false;
}
LinuxParameters other = (LinuxParameters) obj;
return hasDevices() == other.hasDevices() && Objects.equals(devices(), other.devices())
&& Objects.equals(initProcessEnabled(), other.initProcessEnabled())
&& Objects.equals(sharedMemorySize(), other.sharedMemorySize()) && hasTmpfs() == other.hasTmpfs()
&& Objects.equals(tmpfs(), other.tmpfs()) && Objects.equals(maxSwap(), other.maxSwap())
&& Objects.equals(swappiness(), other.swappiness());
}
/**
* 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("LinuxParameters").add("Devices", hasDevices() ? devices() : null)
.add("InitProcessEnabled", initProcessEnabled()).add("SharedMemorySize", sharedMemorySize())
.add("Tmpfs", hasTmpfs() ? tmpfs() : null).add("MaxSwap", maxSwap()).add("Swappiness", swappiness()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "devices":
return Optional.ofNullable(clazz.cast(devices()));
case "initProcessEnabled":
return Optional.ofNullable(clazz.cast(initProcessEnabled()));
case "sharedMemorySize":
return Optional.ofNullable(clazz.cast(sharedMemorySize()));
case "tmpfs":
return Optional.ofNullable(clazz.cast(tmpfs()));
case "maxSwap":
return Optional.ofNullable(clazz.cast(maxSwap()));
case "swappiness":
return Optional.ofNullable(clazz.cast(swappiness()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function