Class AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails.Builder,
AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails>
Information about a Docker volume.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to create the Docker volume automatically if it does not already exist.builder()
final String
driver()
The Docker volume driver to use.A map of Docker driver-specific options that are passed through.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DriverOpts property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Labels property.labels()
Custom metadata to add to the Docker volume.final String
scope()
The scope for the Docker volume that determines its lifecycle.static Class
<? extends AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
autoprovision
Whether to create the Docker volume automatically if it does not already exist.
- Returns:
- Whether to create the Docker volume automatically if it does not already exist.
-
driver
The Docker volume driver to use.
- Returns:
- The Docker volume driver to use.
-
hasDriverOpts
public final boolean hasDriverOpts()For responses, this returns true if the service returned a value for the DriverOpts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
driverOpts
A map of Docker driver-specific options that are passed through.
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
hasDriverOpts()
method.- Returns:
- A map of Docker driver-specific options that are passed through.
-
hasLabels
public final boolean hasLabels()For responses, this returns true if the service returned a value for the Labels property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
labels
Custom metadata to add to the Docker volume.
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
hasLabels()
method.- Returns:
- Custom metadata to add to the Docker volume.
-
scope
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are
shared
ortask
.- Returns:
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task
are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that
are shared persist after the task stops. Valid values are
shared
ortask
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails.Builder,
AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails.Builder> serializableBuilderClass() -
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-