com.amazonaws.services.glacier.model

## クラス ListJobsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.glacier.model.ListJobsRequest

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

      public class ListJobsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `ListJobs operation`.

  This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

  NOTE: Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

  To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data, and for an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

  This List Jobs operation supports pagination. By default, this operation returns up to 1,000 jobs in the response. You should always check the response for a `marker` at which to continue the list; if there are no more items the `marker` is `null` . To return a list of jobs that begins at a specific job, set the `marker` request parameter to the value you obtained from a previous List Jobs request. You can also limit the number of jobs returned in the response by specifying the `limit` parameter in the request.

  Additionally, you can filter the jobs list returned by specifying an optional `statuscode` (InProgress, Succeeded, or Failed) and `completed` (true, false) parameter. The `statuscode` allows you to specify that only jobs that match a specified status are returned. The `completed` parameter allows you to specify that only jobs in a specific completion state are returned.

  An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

  For the underlying REST API, go to List Jobs

  関連項目:
    `AmazonGlacier.listJobs(ListJobsRequest)`, 直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `ListJobsRequest()` Default constructor for a new ListJobsRequest object.
    `ListJobsRequest(java.lang.String vaultName)` Constructs a new ListJobsRequest object.
    `ListJobsRequest(java.lang.String accountId, java.lang.String vaultName)` Constructs a new ListJobsRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAccountId()` The `AccountId` is the AWS Account ID.
    `java.lang.String` | `getCompleted()` Specifies the state of the jobs to return.
    `java.lang.String` | `getLimit()` Specifies that the response be limited to the specified number of items or fewer.
    `java.lang.String` | `getMarker()` An opaque string used for pagination.
    `java.lang.String` | `getStatuscode()` Specifies the type of job status to return.
    `java.lang.String` | `getVaultName()` The name of the vault.
    `int` | `hashCode()`
    `void` | `setAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `void` | `setCompleted(java.lang.String completed)` Specifies the state of the jobs to return.
    `void` | `setLimit(java.lang.String limit)` Specifies that the response be limited to the specified number of items or fewer.
    `void` | `setMarker(java.lang.String marker)` An opaque string used for pagination.
    `void` | `setStatuscode(java.lang.String statuscode)` Specifies the type of job status to return.
    `void` | `setVaultName(java.lang.String vaultName)` The name of the vault.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `ListJobsRequest` | `withAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `ListJobsRequest` | `withCompleted(java.lang.String completed)` Specifies the state of the jobs to return.
    `ListJobsRequest` | `withLimit(java.lang.String limit)` Specifies that the response be limited to the specified number of items or fewer.
    `ListJobsRequest` | `withMarker(java.lang.String marker)` An opaque string used for pagination.
    `ListJobsRequest` | `withStatuscode(java.lang.String statuscode)` Specifies the type of job status to return.
    `ListJobsRequest` | `withVaultName(java.lang.String vaultName)` The name of the vault.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### ListJobsRequest

          public ListJobsRequest()

      Default constructor for a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

    - #### ListJobsRequest

          public ListJobsRequest(java.lang.String vaultName)

      Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `vaultName` - The name of the vault.

    - #### ListJobsRequest

          public ListJobsRequest(java.lang.String accountId,
                         java.lang.String vaultName)

      Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
        `vaultName` - The name of the vault.

  - ### メソッドの詳細

    - #### getAccountId

          public java.lang.String getAccountId()

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
      戻り値:
        The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### setAccountId

          public void setAccountId(java.lang.String accountId)

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.
      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### withAccountId

          public ListJobsRequest withAccountId(java.lang.String accountId)

      The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

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

      パラメータ:
        `accountId` - The `AccountId` is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', in which case Amazon Glacier uses the AWS Account ID associated with the credentials used to sign the request. If you specify your Account ID, do not include hyphens in it.

    - #### getVaultName

          public java.lang.String getVaultName()

      The name of the vault.
      戻り値:
        The name of the vault.

    - #### setVaultName

          public void setVaultName(java.lang.String vaultName)

      The name of the vault.
      パラメータ:
        `vaultName` - The name of the vault.

    - #### withVaultName

          public ListJobsRequest withVaultName(java.lang.String vaultName)

      The name of the vault.

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

      パラメータ:
        `vaultName` - The name of the vault.

    - #### getLimit

          public java.lang.String getLimit()

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
      戻り値:
        Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

    - #### setLimit

          public void setLimit(java.lang.String limit)

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
      パラメータ:
        `limit` - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

    - #### withLimit

          public ListJobsRequest withLimit(java.lang.String limit)

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

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

      パラメータ:
        `limit` - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

    - #### getMarker

          public java.lang.String getMarker()

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
      戻り値:
        An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

    - #### setMarker

          public void setMarker(java.lang.String marker)

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
      パラメータ:
        `marker` - An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

    - #### withMarker

          public ListJobsRequest withMarker(java.lang.String marker)

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

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

      パラメータ:
        `marker` - An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

    - #### getStatuscode

          public java.lang.String getStatuscode()

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
      戻り値:
        Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

    - #### setStatuscode

          public void setStatuscode(java.lang.String statuscode)

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
      パラメータ:
        `statuscode` - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

    - #### withStatuscode

          public ListJobsRequest withStatuscode(java.lang.String statuscode)

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

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

      パラメータ:
        `statuscode` - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

    - #### getCompleted

          public java.lang.String getCompleted()

      Specifies the state of the jobs to return. You can specify `true` or `false`.
      戻り値:
        Specifies the state of the jobs to return. You can specify `true` or `false`.

    - #### setCompleted

          public void setCompleted(java.lang.String completed)

      Specifies the state of the jobs to return. You can specify `true` or `false`.
      パラメータ:
        `completed` - Specifies the state of the jobs to return. You can specify `true` or `false`.

    - #### withCompleted

          public ListJobsRequest withCompleted(java.lang.String completed)

      Specifies the state of the jobs to return. You can specify `true` or `false`.

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

      パラメータ:
        `completed` - Specifies the state of the jobs to return. You can specify `true` or `false`.

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