com.amazonaws.services.storagegateway.model

Class AttachVolumeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.AttachVolumeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AttachVolumeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

AttachVolumeInput

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AttachVolumeRequest()

Method Summary

Modifier and Type	Method and Description
AttachVolumeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDiskId() The unique device ID or other distinguishing data that identifies the local disk used to create the volume.
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
String	getNetworkInterfaceId() The network interface of the gateway on which to expose the iSCSI target.
String	getTargetName() The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
String	getVolumeARN() The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
int	hashCode()
void	setDiskId(String diskId) The unique device ID or other distinguishing data that identifies the local disk used to create the volume.
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
void	setNetworkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
void	setTargetName(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.
void	setVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.
String	toString() Returns a string representation of this object.
AttachVolumeRequest	withDiskId(String diskId) The unique device ID or other distinguishing data that identifies the local disk used to create the volume.
AttachVolumeRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.
AttachVolumeRequest	withNetworkInterfaceId(String networkInterfaceId) The network interface of the gateway on which to expose the iSCSI target.
AttachVolumeRequest	withTargetName(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	withVolumeARN(String volumeARN) The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachVolumeRequest

public AttachVolumeRequest()

Method Detail

setGatewayARN

public void setGatewayARN(String gatewayARN)

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

Parameters:

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

getGatewayARN

public String getGatewayARN()

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.

withGatewayARN

public AttachVolumeRequest withGatewayARN(String gatewayARN)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetName

public void setTargetName(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.

Parameters:

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.

getTargetName

public String getTargetName()

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.

withTargetName

public AttachVolumeRequest withTargetName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setVolumeARN

public void setVolumeARN(String volumeARN)

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

Parameters:

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

getVolumeARN

public String getVolumeARN()

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.

withVolumeARN

public AttachVolumeRequest withVolumeARN(String volumeARN)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNetworkInterfaceId

public void setNetworkInterfaceId(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.

Parameters:

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.

getNetworkInterfaceId

public String getNetworkInterfaceId()

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.

withNetworkInterfaceId

public AttachVolumeRequest withNetworkInterfaceId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDiskId

public void setDiskId(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.

Parameters:

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.

getDiskId

public String getDiskId()

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.

withDiskId

public AttachVolumeRequest withDiskId(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.

Parameters:

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:

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 AttachVolumeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()