com.amazonaws.services.storagegateway.model

## クラス CreateCachediSCSIVolumeRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.storagegateway.model.CreateCachediSCSIVolumeRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class CreateCachediSCSIVolumeRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `CreateCachediSCSIVolume operation`.

  This operation creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

  NOTE:Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

  In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

  関連項目:
    `AWSStorageGateway.createCachediSCSIVolume(CreateCachediSCSIVolumeRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `CreateCachediSCSIVolumeRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getClientToken()` A unique identifying string for the cached volume.
    `java.lang.String` | `getGatewayARN()` The Amazon Resource Name (ARN) of the gateway.
    `java.lang.String` | `getNetworkInterfaceId()` The network interface of the gateway on which to expose the iSCSI target.
    `java.lang.String` | `getSnapshotId()` The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume.
    `java.lang.String` | `getTargetName()` The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
    `java.lang.Long` | `getVolumeSizeInBytes()` The size of the cached volume.
    `int` | `hashCode()`
    `void` | `setClientToken(java.lang.String clientToken)` A unique identifying string for the cached volume.
    `void` | `setGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `void` | `setNetworkInterfaceId(java.lang.String networkInterfaceId)` The network interface of the gateway on which to expose the iSCSI target.
    `void` | `setSnapshotId(java.lang.String snapshotId)` The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume.
    `void` | `setTargetName(java.lang.String targetName)` The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
    `void` | `setVolumeSizeInBytes(java.lang.Long volumeSizeInBytes)` The size of the cached volume.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `CreateCachediSCSIVolumeRequest` | `withClientToken(java.lang.String clientToken)` A unique identifying string for the cached volume.
    `CreateCachediSCSIVolumeRequest` | `withGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `CreateCachediSCSIVolumeRequest` | `withNetworkInterfaceId(java.lang.String networkInterfaceId)` The network interface of the gateway on which to expose the iSCSI target.
    `CreateCachediSCSIVolumeRequest` | `withSnapshotId(java.lang.String snapshotId)` The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume.
    `CreateCachediSCSIVolumeRequest` | `withTargetName(java.lang.String targetName)` The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN.
    `CreateCachediSCSIVolumeRequest` | `withVolumeSizeInBytes(java.lang.Long volumeSizeInBytes)` The size of the cached volume.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### CreateCachediSCSIVolumeRequest

          public CreateCachediSCSIVolumeRequest()

  - ### メソッドの詳細

    - #### getGatewayARN

          public java.lang.String getGatewayARN()

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

      Constraints:
      Length: 50 - 500

      戻り値:
        The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

    - #### setGatewayARN

          public void setGatewayARN(java.lang.String gatewayARN)

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

      Constraints:
      Length: 50 - 500

      パラメータ:
        `gatewayARN` - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

    - #### withGatewayARN

          public CreateCachediSCSIVolumeRequest withGatewayARN(java.lang.String gatewayARN)

      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

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

      Constraints:
      Length: 50 - 500

      パラメータ:
        `gatewayARN` - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

    - #### getVolumeSizeInBytes

          public java.lang.Long getVolumeSizeInBytes()

      The size of the cached volume.
      戻り値:
        The size of the cached volume.

    - #### setVolumeSizeInBytes

          public void setVolumeSizeInBytes(java.lang.Long volumeSizeInBytes)

      The size of the cached volume.
      パラメータ:
        `volumeSizeInBytes` - The size of the cached volume.

    - #### withVolumeSizeInBytes

          public CreateCachediSCSIVolumeRequest withVolumeSizeInBytes(java.lang.Long volumeSizeInBytes)

      The size of the cached volume.

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

      パラメータ:
        `volumeSizeInBytes` - The size of the cached volume.

    - #### getSnapshotId

          public java.lang.String getSnapshotId()

      The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

      Constraints:
      Pattern: \Asnap-[0-9a-fA-F]{8}\z

      戻り値:
        The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

    - #### setSnapshotId

          public void setSnapshotId(java.lang.String snapshotId)

      The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

      Constraints:
      Pattern: \Asnap-[0-9a-fA-F]{8}\z

      パラメータ:
        `snapshotId` - The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

    - #### withSnapshotId

          public CreateCachediSCSIVolumeRequest withSnapshotId(java.lang.String snapshotId)

      The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

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

      Constraints:
      Pattern: \Asnap-[0-9a-fA-F]{8}\z

      パラメータ:
        `snapshotId` - The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI cached volume from a snapshot; otherwise, do not include this field. To list snapshots for your account, use DescribeSnapshots in Amazon Elastic Compute Cloud API Reference.

    - #### getTargetName

          public java.lang.String getTargetName()

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

      Constraints:
      Length: 1 - 200
      Pattern: ^[-\.;a-z0-9]+$

      戻り値:
        The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

    - #### setTargetName

          public void setTargetName(java.lang.String targetName)

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

      Constraints:
      Length: 1 - 200
      Pattern: ^[-\.;a-z0-9]+$

      パラメータ:
        `targetName` - The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

    - #### withTargetName

          public CreateCachediSCSIVolumeRequest withTargetName(java.lang.String targetName)

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

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

      Constraints:
      Length: 1 - 200
      Pattern: ^[-\.;a-z0-9]+$

      パラメータ:
        `targetName` - The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

    - #### getNetworkInterfaceId

          public java.lang.String getNetworkInterfaceId()

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

      Constraints:
      Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

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

    - #### setNetworkInterfaceId

          public void setNetworkInterfaceId(java.lang.String networkInterfaceId)

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

      Constraints:
      Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

      パラメータ:
        `networkInterfaceId` - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

    - #### withNetworkInterfaceId

          public CreateCachediSCSIVolumeRequest withNetworkInterfaceId(java.lang.String networkInterfaceId)

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

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

      Constraints:
      Pattern: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

      パラメータ:
        `networkInterfaceId` - The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use the DescribeGatewayInformation operation to get a list of the network interfaces available on the gateway.

    - #### getClientToken

          public java.lang.String getClientToken()

      A unique identifying string for the cached volume.

      Constraints:
      Length: 5 - 100

      戻り値:
        A unique identifying string for the cached volume.

    - #### setClientToken

          public void setClientToken(java.lang.String clientToken)

      A unique identifying string for the cached volume.

      Constraints:
      Length: 5 - 100

      パラメータ:
        `clientToken` - A unique identifying string for the cached volume.

    - #### withClientToken

          public CreateCachediSCSIVolumeRequest withClientToken(java.lang.String clientToken)

      A unique identifying string for the cached volume.

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

      Constraints:
      Length: 5 - 100

      パラメータ:
        `clientToken` - A unique identifying string for the cached volume.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`