public class Volume
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
A data volume used in a task definition.
Modifier and Type | Field and Description |
---|---|
private HostVolumeProperties |
host
The contents of the
host parameter determine whether your
data volume persists on the host container instance and where it is
stored. |
private java.lang.String |
name
The name of the volume.
|
Constructor and Description |
---|
Volume() |
Modifier and Type | Method and Description |
---|---|
Volume |
clone() |
boolean |
equals(java.lang.Object obj) |
HostVolumeProperties |
getHost()
The contents of the
host parameter determine whether your
data volume persists on the host container instance and where it is
stored. |
java.lang.String |
getName()
The name of the volume.
|
int |
hashCode() |
void |
setHost(HostVolumeProperties host)
The contents of the
host parameter determine whether your
data volume persists on the host container instance and where it is
stored. |
void |
setName(java.lang.String name)
The name of the volume.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
Volume |
withHost(HostVolumeProperties host)
The contents of the
host parameter determine whether your
data volume persists on the host container instance and where it is
stored. |
Volume |
withName(java.lang.String name)
The name of the volume.
|
private java.lang.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
.
private HostVolumeProperties 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, but the data is not guaranteed to persist
after the containers associated with it stop running.
public void setName(java.lang.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
.
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
.public java.lang.String getName()
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
.
sourceVolume
parameter of
container definition mountPoints
.public Volume withName(java.lang.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
.
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
.public void setHost(HostVolumeProperties 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, but the data is not guaranteed to persist
after the containers associated with it stop running.
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, but the data is
not guaranteed to persist after the containers associated with it
stop running.public HostVolumeProperties getHost()
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, but the data is not guaranteed to persist
after the containers associated with it stop running.
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, but the
data is not guaranteed to persist after the containers associated
with it stop running.public Volume withHost(HostVolumeProperties 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, but the data is not guaranteed to persist
after the containers associated with it stop running.
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, but the data is
not guaranteed to persist after the containers associated with it
stop running.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public Volume clone()
clone
in class java.lang.Object