Volume (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.Volume

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Volume
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A data volume that's used in a job's container properties.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Volume()

Constructors
Constructor and Description
`Volume()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Volume`	`clone()`
`boolean`	`equals(Object obj)`
`EFSVolumeConfiguration`	`getEfsVolumeConfiguration()` This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
`Host`	`getHost()` The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it's stored.
`String`	`getName()` The name of the volume.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)` This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
`void`	`setHost(Host host)` The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it's stored.
`void`	`setName(String name)` The name of the volume.
`String`	`toString()` Returns a string representation of this object.
`Volume`	`withEfsVolumeConfiguration(EFSVolumeConfiguration efsVolumeConfiguration)` This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
`Volume`	`withHost(Host host)` The contents of the `host` parameter determine whether your data volume persists on the host container instance and where it's stored.
`Volume`	`withName(String name)` The name of the volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Volume
```
public Volume()
```
- Method Detail
  - setHost
```
public void setHost(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.
    
    Parameters:
    
    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.
  - getHost
```
public Host getHost()
```
    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.
  - withHost
```
public Volume withHost(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public Volume withName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEfsVolumeConfiguration
```
public void setEfsVolumeConfiguration(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.
    
    Parameters:
    
    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.
  - getEfsVolumeConfiguration
```
public EFSVolumeConfiguration getEfsVolumeConfiguration()
```
    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.
  - withEfsVolumeConfiguration
```
public Volume withEfsVolumeConfiguration(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Volume clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Volume

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Volume

Method Detail

setHost

getHost

withHost

setName

getName

withName

setEfsVolumeConfiguration

getEfsVolumeConfiguration

withEfsVolumeConfiguration

toString

equals

hashCode

clone

marshall