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

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<AttachVolumeRequest.Builder,AttachVolumeRequest>
      Specified by:
      toBuilder in class StorageGatewayRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.