com.amazonaws.services.glacier.model

## クラス DeleteArchiveRequest

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

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

      public class DeleteArchiveRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DeleteArchive operation`.

  This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  - If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.
  - If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

  This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

  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 Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide .

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAccountId()` The `AccountId` is the AWS Account ID.
    `java.lang.String` | `getArchiveId()` The ID of the archive to delete.
    `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` | `setArchiveId(java.lang.String archiveId)` The ID of the archive to delete.
    `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.
    `DeleteArchiveRequest` | `withAccountId(java.lang.String accountId)` The `AccountId` is the AWS Account ID.
    `DeleteArchiveRequest` | `withArchiveId(java.lang.String archiveId)` The ID of the archive to delete.
    `DeleteArchiveRequest` | `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`

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

    - #### DeleteArchiveRequest

          public DeleteArchiveRequest()

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

    - #### DeleteArchiveRequest

          public DeleteArchiveRequest(java.lang.String vaultName,
                              java.lang.String archiveId)

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

    - #### DeleteArchiveRequest

          public DeleteArchiveRequest(java.lang.String accountId,
                              java.lang.String vaultName,
                              java.lang.String archiveId)

      Constructs a new DeleteArchiveRequest 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.
        `archiveId` - The ID of the archive to delete.

  - ### メソッドの詳細

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

    - #### getArchiveId

          public java.lang.String getArchiveId()

      The ID of the archive to delete.
      戻り値:
        The ID of the archive to delete.

    - #### setArchiveId

          public void setArchiveId(java.lang.String archiveId)

      The ID of the archive to delete.
      パラメータ:
        `archiveId` - The ID of the archive to delete.

    - #### withArchiveId

          public DeleteArchiveRequest withArchiveId(java.lang.String archiveId)

      The ID of the archive to delete.

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

      パラメータ:
        `archiveId` - The ID of the archive to delete.

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