Class AttachVolumeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AttachVolumeRequest.Builder,
AttachVolumeRequest>
AttachVolumeInput
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AttachVolumeRequest.Builder
builder()
final String
diskId()
The unique device ID or other distinguishing data that identifies the local disk used to create the volume.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The network interface of the gateway on which to expose the iSCSI target.static Class
<? extends AttachVolumeRequest.Builder> final String
The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.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.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 ofarn: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 ofarn: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
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
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
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
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<AttachVolumeRequest.Builder,
AttachVolumeRequest> - Specified by:
toBuilder
in classStorageGatewayRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-