com.amazonaws.services.storagegateway.model

## クラス ListVolumesRequest

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

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

      public class ListVolumesRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ListVolumes operation`.

  This operation lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes API.

  The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the `Limit` field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getGatewayARN()` The Amazon Resource Name (ARN) of the gateway.
    `java.lang.Integer` | `getLimit()` Specifies that the list of volumes returned be limited to the specified number of items.
    `java.lang.String` | `getMarker()` A string that indicates the position at which to begin the returned list of volumes.
    `int` | `hashCode()`
    `void` | `setGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `void` | `setLimit(java.lang.Integer limit)` Specifies that the list of volumes returned be limited to the specified number of items.
    `void` | `setMarker(java.lang.String marker)` A string that indicates the position at which to begin the returned list of volumes.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ListVolumesRequest` | `withGatewayARN(java.lang.String gatewayARN)` The Amazon Resource Name (ARN) of the gateway.
    `ListVolumesRequest` | `withLimit(java.lang.Integer limit)` Specifies that the list of volumes returned be limited to the specified number of items.
    `ListVolumesRequest` | `withMarker(java.lang.String marker)` A string that indicates the position at which to begin the returned list of volumes.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### ListVolumesRequest

          public ListVolumesRequest()

  - ### メソッドの詳細

    - #### 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 ListVolumesRequest 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.

    - #### getMarker

          public java.lang.String getMarker()

      A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

      Constraints:
      Length: 1 - 1000

      戻り値:
        A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    - #### setMarker

          public void setMarker(java.lang.String marker)

      A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

      Constraints:
      Length: 1 - 1000

      パラメータ:
        `marker` - A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    - #### withMarker

          public ListVolumesRequest withMarker(java.lang.String marker)

      A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

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

      Constraints:
      Length: 1 - 1000

      パラメータ:
        `marker` - A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    - #### getLimit

          public java.lang.Integer getLimit()

      Specifies that the list of volumes returned be limited to the specified number of items.

      Constraints:
      Range: 1 -

      戻り値:
        Specifies that the list of volumes returned be limited to the specified number of items.

    - #### setLimit

          public void setLimit(java.lang.Integer limit)

      Specifies that the list of volumes returned be limited to the specified number of items.

      Constraints:
      Range: 1 -

      パラメータ:
        `limit` - Specifies that the list of volumes returned be limited to the specified number of items.

    - #### withLimit

          public ListVolumesRequest withLimit(java.lang.Integer limit)

      Specifies that the list of volumes returned be limited to the specified number of items.

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

      Constraints:
      Range: 1 -

      パラメータ:
        `limit` - Specifies that the list of volumes returned be limited to the specified number of items.

    - #### 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`