software.amazon.awssdk.services.batch.model

Class Volume

java.lang.Object

software.amazon.awssdk.services.batch.model.Volume

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>

@Generated(value="software.amazon.awssdk:codegen")
public final class Volume
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>

A data volume used in a job's container properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Volume.Builder

Method Summary

Modifier and Type	Method and Description
static Volume.Builder	builder()
EFSVolumeConfiguration	efsVolumeConfiguration() This parameter is specified when you are using an Amazon Elastic File System file system for job storage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Host	host() The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored.
String	name() The name of the volume.
List<SdkField<?>>	sdkFields()
static Class<? extends Volume.Builder>	serializableBuilderClass()
Volume.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

host

public final Host host()

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

Returns:

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers associated with it stop running.

This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.

name

public final String name()

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

Returns:

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

efsVolumeConfiguration

public final EFSVolumeConfiguration efsVolumeConfiguration()

This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs running on Fargate resources must specify a platformVersion of at least 1.4.0.

Returns:

This parameter is specified when you are using an Amazon Elastic File System file system for job storage. Jobs running on Fargate resources must specify a platformVersion of at least 1.4.0.

toBuilder

public Volume.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Volume.Builder,Volume>

builder

public static Volume.Builder builder()

serializableBuilderClass

public static Class<? extends Volume.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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