Package software.amazon.awssdk.services.storagegateway.model

Class AttachVolumeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.AttachVolumeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AttachVolumeRequest.Builder,AttachVolumeRequest>

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

AttachVolumeInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AttachVolumeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AttachVolumeRequest.Builder	builder()
String	diskId()	The unique device ID or other distinguishing data that identifies the local disk used to create the volume.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN()	The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	networkInterfaceId()	The network interface of the gateway on which to expose the iSCSI target.
List<SdkField<?>>	sdkFields()
static Class<? extends AttachVolumeRequest.Builder>	serializableBuilderClass()
String	targetName()	The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
AttachVolumeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeARN()	The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

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

gatewayARN

public final String gatewayARN()

The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

Returns:

The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

targetName

public final String targetName()

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

volumeARN

public final String volumeARN()

The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

Returns:

The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

networkInterfaceId

public final String networkInterfaceId()

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Returns:

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

diskId

public final String diskId()

The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

Returns:

The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

toBuilder

public AttachVolumeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttachVolumeRequest.Builder,AttachVolumeRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static AttachVolumeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AttachVolumeRequest.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