com.amazonaws.services.glacier.model

## クラス GetJobOutputRequest

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

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

      public class GetJobOutputRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `GetJobOutput operation`.

  This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

  A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

  If the job output is large, then you can use the `Range` request header to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range using the `Range` header.

  2. Along with the data, the response includes a checksum of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the Describe Job API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

  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 conceptual information and the underlying REST API, go to Downloading a Vault Inventory , Downloading an Archive , and Get Job Output

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAccountId()` The `AccountId` is the AWS Account ID.
    `java.lang.String` | `getJobId()` The job ID whose data is downloaded.
    `java.lang.String` | `getRange()` The range of bytes to retrieve from the output.
    `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` | `setJobId(java.lang.String jobId)` The job ID whose data is downloaded.
    `void` | `setRange(java.lang.String range)` The range of bytes to retrieve from the output.
    `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.
    `GetJobOutputRequest` | `withAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `GetJobOutputRequest` | `withJobId(java.lang.String jobId)` The job ID whose data is downloaded.
    `GetJobOutputRequest` | `withRange(java.lang.String range)` The range of bytes to retrieve from the output.
    `GetJobOutputRequest` | `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`

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

    - #### GetJobOutputRequest

          public GetJobOutputRequest()

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

    - #### GetJobOutputRequest

          public GetJobOutputRequest(java.lang.String vaultName,
                             java.lang.String jobId,
                             java.lang.String range)

      Constructs a new GetJobOutputRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `vaultName` - The name of the vault.
        `jobId` - The job ID whose data is downloaded.
        `range` - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

    - #### GetJobOutputRequest

          public GetJobOutputRequest(java.lang.String accountId,
                             java.lang.String vaultName,
                             java.lang.String jobId,
                             java.lang.String range)

      Constructs a new GetJobOutputRequest 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.
        `jobId` - The job ID whose data is downloaded.
        `range` - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

  - ### メソッドの詳細

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

    - #### getJobId

          public java.lang.String getJobId()

      The job ID whose data is downloaded.
      戻り値:
        The job ID whose data is downloaded.

    - #### setJobId

          public void setJobId(java.lang.String jobId)

      The job ID whose data is downloaded.
      パラメータ:
        `jobId` - The job ID whose data is downloaded.

    - #### withJobId

          public GetJobOutputRequest withJobId(java.lang.String jobId)

      The job ID whose data is downloaded.

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

      パラメータ:
        `jobId` - The job ID whose data is downloaded.

    - #### getRange

          public java.lang.String getRange()

      The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.
      戻り値:
        The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

    - #### setRange

          public void setRange(java.lang.String range)

      The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.
      パラメータ:
        `range` - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

    - #### withRange

          public GetJobOutputRequest withRange(java.lang.String range)

      The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

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

      パラメータ:
        `range` - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

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