Package 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("software.amazon.awssdk:codegen")
public final class Volume
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Volume.Builder

Method Summary

Modifier and Type	Method	Description
static Volume.Builder	builder()
EFSVolumeConfiguration	efsVolumeConfiguration()	This parameter is specified when you're 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's 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's 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 that are associated with it stop running.

This parameter isn't applicable to jobs that are 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's 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 that are associated with it stop running.

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

name

public final String name()

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

Returns:

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.

efsVolumeConfiguration

public final EFSVolumeConfiguration efsVolumeConfiguration()

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

Returns:

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are 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