com.amazonaws.services.glacier.model

## クラス UploadArchiveRequest

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

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

      public class UploadArchiveRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `UploadArchive operation`.

  This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the `x-amz-archive-id` header of the response.

  You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

  You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums .

  You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

  Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

  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 underlying REST API, go to Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide .

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

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

    コンストラクタ
    コンストラクタと説明
    `UploadArchiveRequest()` Default constructor for a new UploadArchiveRequest object.
    `UploadArchiveRequest(java.lang.String vaultName, java.lang.String archiveDescription, java.lang.String checksum, java.io.InputStream body)` Constructs a new UploadArchiveRequest object.
    `UploadArchiveRequest(java.lang.String vaultName, java.lang.String accountId, java.lang.String archiveDescription, java.lang.String checksum, java.io.InputStream body)` Constructs a new UploadArchiveRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAccountId()` The `AccountId` is the AWS Account ID.
    `java.lang.String` | `getArchiveDescription()` The optional description of the archive you are uploading.
    `java.io.InputStream` | `getBody()` The data to upload.
    `java.lang.String` | `getChecksum()` The SHA256 checksum (a linear hash) of the payload.
    `java.lang.Long` | `getContentLength()` Returns the value of the ContentLength property for this object.
    `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` | `setArchiveDescription(java.lang.String archiveDescription)` The optional description of the archive you are uploading.
    `void` | `setBody(java.io.InputStream body)` The data to upload.
    `void` | `setChecksum(java.lang.String checksum)` The SHA256 checksum (a linear hash) of the payload.
    `void` | `setContentLength(java.lang.Long contentLength)` Sets the value of the ContentLength property for this object.
    `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.
    `UploadArchiveRequest` | `withAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `UploadArchiveRequest` | `withArchiveDescription(java.lang.String archiveDescription)` The optional description of the archive you are uploading.
    `UploadArchiveRequest` | `withBody(java.io.InputStream body)` The data to upload.
    `UploadArchiveRequest` | `withChecksum(java.lang.String checksum)` The SHA256 checksum (a linear hash) of the payload.
    `UploadArchiveRequest` | `withContentLength(java.lang.Long contentLength)` Sets the value of the ContentLength property for this object.
    `UploadArchiveRequest` | `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`

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

    - #### UploadArchiveRequest

          public UploadArchiveRequest()

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

    - #### UploadArchiveRequest

          public UploadArchiveRequest(java.lang.String vaultName,
                              java.lang.String archiveDescription,
                              java.lang.String checksum,
                              java.io.InputStream body)

      Constructs a new UploadArchiveRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `vaultName` - The name of the vault.
        `archiveDescription` - The optional description of the archive you are uploading.
        `checksum` - The SHA256 checksum (a linear hash) of the payload.
        `body` - The data to upload.

    - #### UploadArchiveRequest

          public UploadArchiveRequest(java.lang.String vaultName,
                              java.lang.String accountId,
                              java.lang.String archiveDescription,
                              java.lang.String checksum,
                              java.io.InputStream body)

      Constructs a new UploadArchiveRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      パラメータ:
        `vaultName` - The name of the vault.
        `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.
        `archiveDescription` - The optional description of the archive you are uploading.
        `checksum` - The SHA256 checksum (a linear hash) of the payload.
        `body` - The data to upload.

  - ### メソッドの詳細

    - #### getContentLength

          public java.lang.Long getContentLength()

      Returns the value of the ContentLength property for this object.
      戻り値:
        The value of the ContentLength property for this object.

    - #### setContentLength

          public void setContentLength(java.lang.Long contentLength)

      Sets the value of the ContentLength property for this object.
      パラメータ:
        `contentLength` - The new value for the ContentLength property for this object.

    - #### withContentLength

          public UploadArchiveRequest withContentLength(java.lang.Long contentLength)

      Sets the value of the ContentLength property for this object.

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

      パラメータ:
        `contentLength` - The new value for the ContentLength property for this object.

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

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

    - #### getArchiveDescription

          public java.lang.String getArchiveDescription()

      The optional description of the archive you are uploading.
      戻り値:
        The optional description of the archive you are uploading.

    - #### setArchiveDescription

          public void setArchiveDescription(java.lang.String archiveDescription)

      The optional description of the archive you are uploading.
      パラメータ:
        `archiveDescription` - The optional description of the archive you are uploading.

    - #### withArchiveDescription

          public UploadArchiveRequest withArchiveDescription(java.lang.String archiveDescription)

      The optional description of the archive you are uploading.

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

      パラメータ:
        `archiveDescription` - The optional description of the archive you are uploading.

    - #### getChecksum

          public java.lang.String getChecksum()

      The SHA256 checksum (a linear hash) of the payload.
      戻り値:
        The SHA256 checksum (a linear hash) of the payload.

    - #### setChecksum

          public void setChecksum(java.lang.String checksum)

      The SHA256 checksum (a linear hash) of the payload.
      パラメータ:
        `checksum` - The SHA256 checksum (a linear hash) of the payload.

    - #### withChecksum

          public UploadArchiveRequest withChecksum(java.lang.String checksum)

      The SHA256 checksum (a linear hash) of the payload.

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

      パラメータ:
        `checksum` - The SHA256 checksum (a linear hash) of the payload.

    - #### getBody

          public java.io.InputStream getBody()

      The data to upload.
      戻り値:
        The data to upload.

    - #### setBody

          public void setBody(java.io.InputStream body)

      The data to upload.
      パラメータ:
        `body` - The data to upload.

    - #### withBody

          public UploadArchiveRequest withBody(java.io.InputStream body)

      The data to upload.

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

      パラメータ:
        `body` - The data to upload.

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