Package software.amazon.awssdk.services.ec2.model

Class DetachVolumeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DetachVolumeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DetachVolumeRequest.Builder,DetachVolumeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DetachVolumeRequest
extends Ec2Request
implements ToCopyableBuilder<DetachVolumeRequest.Builder,DetachVolumeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DetachVolumeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DetachVolumeRequest.Builder	builder()
String	device()	The device name.
Boolean	dryRun()	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	force()	Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The ID of the instance.
List<SdkField<?>>	sdkFields()
static Class<? extends DetachVolumeRequest.Builder>	serializableBuilderClass()
DetachVolumeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeId()	The ID of the volume.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

device

public final String device()

The device name.

Returns:

The device name.

force

public final Boolean force()

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

Returns:

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

instanceId

public final String instanceId()

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

Returns:

The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.

volumeId

public final String volumeId()

The ID of the volume.

Returns:

The ID of the volume.

dryRun

public final Boolean dryRun()

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

toBuilder

public DetachVolumeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DetachVolumeRequest.Builder,DetachVolumeRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static DetachVolumeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DetachVolumeRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo