com.amazonaws.services.glacier.model

## クラス GlacierJobDescription

- java.lang.Object
- - com.amazonaws.services.glacier.model.GlacierJobDescription

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

      public class GlacierJobDescription
      extends java.lang.Object
      implements java.io.Serializable

  Describes an Amazon Glacier job.

  関連項目:
    直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAction()` The job type.
    `java.lang.String` | `getArchiveId()` For an ArchiveRetrieval job, this is the archive ID requested for download.
    `java.lang.String` | `getArchiveSHA256TreeHash()` Returns the value of the ArchiveSHA256TreeHash property for this object.
    `java.lang.Long` | `getArchiveSizeInBytes()` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
    `java.lang.Boolean` | `getCompleted()` The job status.
    `java.lang.String` | `getCompletionDate()` The UTC time that the archive retrieval request completed.
    `java.lang.String` | `getCreationDate()` The UTC date when the job was created.
    `java.lang.Long` | `getInventorySizeInBytes()` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
    `java.lang.String` | `getJobDescription()` The job description you provided when you initiated the job.
    `java.lang.String` | `getJobId()` An opaque string that identifies an Amazon Glacier job.
    `java.lang.String` | `getRetrievalByteRange()` Returns the value of the RetrievalByteRange property for this object.
    `java.lang.String` | `getSHA256TreeHash()` For an ArchiveRetrieval job, it is the checksum of the archive.
    `java.lang.String` | `getSNSTopic()` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
    `java.lang.String` | `getStatusCode()` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    `java.lang.String` | `getStatusMessage()` A friendly message that describes the job status.
    `java.lang.String` | `getVaultARN()` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isCompleted()` The job status.
    `void` | `setAction(ActionCode action)` The job type.
    `void` | `setAction(java.lang.String action)` The job type.
    `void` | `setArchiveId(java.lang.String archiveId)` For an ArchiveRetrieval job, this is the archive ID requested for download.
    `void` | `setArchiveSHA256TreeHash(java.lang.String archiveSHA256TreeHash)` Sets the value of the ArchiveSHA256TreeHash property for this object.
    `void` | `setArchiveSizeInBytes(java.lang.Long archiveSizeInBytes)` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
    `void` | `setCompleted(java.lang.Boolean completed)` The job status.
    `void` | `setCompletionDate(java.lang.String completionDate)` The UTC time that the archive retrieval request completed.
    `void` | `setCreationDate(java.lang.String creationDate)` The UTC date when the job was created.
    `void` | `setInventorySizeInBytes(java.lang.Long inventorySizeInBytes)` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
    `void` | `setJobDescription(java.lang.String jobDescription)` The job description you provided when you initiated the job.
    `void` | `setJobId(java.lang.String jobId)` An opaque string that identifies an Amazon Glacier job.
    `void` | `setRetrievalByteRange(java.lang.String retrievalByteRange)` Sets the value of the RetrievalByteRange property for this object.
    `void` | `setSHA256TreeHash(java.lang.String sHA256TreeHash)` For an ArchiveRetrieval job, it is the checksum of the archive.
    `void` | `setSNSTopic(java.lang.String sNSTopic)` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
    `void` | `setStatusCode(StatusCode statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    `void` | `setStatusCode(java.lang.String statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    `void` | `setStatusMessage(java.lang.String statusMessage)` A friendly message that describes the job status.
    `void` | `setVaultARN(java.lang.String vaultARN)` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `GlacierJobDescription` | `withAction(ActionCode action)` The job type.
    `GlacierJobDescription` | `withAction(java.lang.String action)` The job type.
    `GlacierJobDescription` | `withArchiveId(java.lang.String archiveId)` For an ArchiveRetrieval job, this is the archive ID requested for download.
    `GlacierJobDescription` | `withArchiveSHA256TreeHash(java.lang.String archiveSHA256TreeHash)` Sets the value of the ArchiveSHA256TreeHash property for this object.
    `GlacierJobDescription` | `withArchiveSizeInBytes(java.lang.Long archiveSizeInBytes)` For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download.
    `GlacierJobDescription` | `withCompleted(java.lang.Boolean completed)` The job status.
    `GlacierJobDescription` | `withCompletionDate(java.lang.String completionDate)` The UTC time that the archive retrieval request completed.
    `GlacierJobDescription` | `withCreationDate(java.lang.String creationDate)` The UTC date when the job was created.
    `GlacierJobDescription` | `withInventorySizeInBytes(java.lang.Long inventorySizeInBytes)` For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download.
    `GlacierJobDescription` | `withJobDescription(java.lang.String jobDescription)` The job description you provided when you initiated the job.
    `GlacierJobDescription` | `withJobId(java.lang.String jobId)` An opaque string that identifies an Amazon Glacier job.
    `GlacierJobDescription` | `withRetrievalByteRange(java.lang.String retrievalByteRange)` Sets the value of the RetrievalByteRange property for this object.
    `GlacierJobDescription` | `withSHA256TreeHash(java.lang.String sHA256TreeHash)` For an ArchiveRetrieval job, it is the checksum of the archive.
    `GlacierJobDescription` | `withSNSTopic(java.lang.String sNSTopic)` An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
    `GlacierJobDescription` | `withStatusCode(StatusCode statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    `GlacierJobDescription` | `withStatusCode(java.lang.String statusCode)` The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
    `GlacierJobDescription` | `withStatusMessage(java.lang.String statusMessage)` A friendly message that describes the job status.
    `GlacierJobDescription` | `withVaultARN(java.lang.String vaultARN)` The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

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

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

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

    - #### GlacierJobDescription

          public GlacierJobDescription()

  - ### メソッドの詳細

    - #### getJobId

          public java.lang.String getJobId()

      An opaque string that identifies an Amazon Glacier job.
      戻り値:
        An opaque string that identifies an Amazon Glacier job.

    - #### setJobId

          public void setJobId(java.lang.String jobId)

      An opaque string that identifies an Amazon Glacier job.
      パラメータ:
        `jobId` - An opaque string that identifies an Amazon Glacier job.

    - #### withJobId

          public GlacierJobDescription withJobId(java.lang.String jobId)

      An opaque string that identifies an Amazon Glacier job.

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

      パラメータ:
        `jobId` - An opaque string that identifies an Amazon Glacier job.

    - #### getJobDescription

          public java.lang.String getJobDescription()

      The job description you provided when you initiated the job.
      戻り値:
        The job description you provided when you initiated the job.

    - #### setJobDescription

          public void setJobDescription(java.lang.String jobDescription)

      The job description you provided when you initiated the job.
      パラメータ:
        `jobDescription` - The job description you provided when you initiated the job.

    - #### withJobDescription

          public GlacierJobDescription withJobDescription(java.lang.String jobDescription)

      The job description you provided when you initiated the job.

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

      パラメータ:
        `jobDescription` - The job description you provided when you initiated the job.

    - #### getAction

          public java.lang.String getAction()

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

      Constraints:
      Allowed Values: ArchiveRetrieval, InventoryRetrieval

      戻り値:
        The job type. It is either ArchiveRetrieval or InventoryRetrieval.
      関連項目:
        `ActionCode`

    - #### setAction

          public void setAction(java.lang.String action)

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

      Constraints:
      Allowed Values: ArchiveRetrieval, InventoryRetrieval

      パラメータ:
        `action` - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
      関連項目:
        `ActionCode`

    - #### withAction

          public GlacierJobDescription withAction(java.lang.String action)

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

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

      Constraints:
      Allowed Values: ArchiveRetrieval, InventoryRetrieval

      パラメータ:
        `action` - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
      関連項目:
        `ActionCode`

    - #### setAction

          public void setAction(ActionCode action)

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

      Constraints:
      Allowed Values: ArchiveRetrieval, InventoryRetrieval

      パラメータ:
        `action` - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
      関連項目:
        `ActionCode`

    - #### withAction

          public GlacierJobDescription withAction(ActionCode action)

      The job type. It is either ArchiveRetrieval or InventoryRetrieval.

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

      Constraints:
      Allowed Values: ArchiveRetrieval, InventoryRetrieval

      パラメータ:
        `action` - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
      関連項目:
        `ActionCode`

    - #### getArchiveId

          public java.lang.String getArchiveId()

      For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
      戻り値:
        For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

    - #### setArchiveId

          public void setArchiveId(java.lang.String archiveId)

      For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
      パラメータ:
        `archiveId` - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

    - #### withArchiveId

          public GlacierJobDescription withArchiveId(java.lang.String archiveId)

      For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

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

      パラメータ:
        `archiveId` - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

    - #### getVaultARN

          public java.lang.String getVaultARN()

      The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
      戻り値:
        The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

    - #### setVaultARN

          public void setVaultARN(java.lang.String vaultARN)

      The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
      パラメータ:
        `vaultARN` - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

    - #### withVaultARN

          public GlacierJobDescription withVaultARN(java.lang.String vaultARN)

      The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

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

      パラメータ:
        `vaultARN` - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

    - #### getCreationDate

          public java.lang.String getCreationDate()

      The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
      戻り値:
        The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    - #### setCreationDate

          public void setCreationDate(java.lang.String creationDate)

      The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".
      パラメータ:
        `creationDate` - The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    - #### withCreationDate

          public GlacierJobDescription withCreationDate(java.lang.String creationDate)

      The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

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

      パラメータ:
        `creationDate` - The UTC date when the job was created. A string representation of ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".

    - #### isCompleted

          public java.lang.Boolean isCompleted()

      The job status. When a job is completed, you get the job's output.
      戻り値:
        The job status. When a job is completed, you get the job's output.

    - #### setCompleted

          public void setCompleted(java.lang.Boolean completed)

      The job status. When a job is completed, you get the job's output.
      パラメータ:
        `completed` - The job status. When a job is completed, you get the job's output.

    - #### withCompleted

          public GlacierJobDescription withCompleted(java.lang.Boolean completed)

      The job status. When a job is completed, you get the job's output.

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

      パラメータ:
        `completed` - The job status. When a job is completed, you get the job's output.

    - #### getCompleted

          public java.lang.Boolean getCompleted()

      The job status. When a job is completed, you get the job's output.
      戻り値:
        The job status. When a job is completed, you get the job's output.

    - #### getStatusCode

          public java.lang.String getStatusCode()

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

      Constraints:
      Allowed Values: InProgress, Succeeded, Failed

      戻り値:
        The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      関連項目:
        `StatusCode`

    - #### setStatusCode

          public void setStatusCode(java.lang.String statusCode)

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

      Constraints:
      Allowed Values: InProgress, Succeeded, Failed

      パラメータ:
        `statusCode` - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      関連項目:
        `StatusCode`

    - #### withStatusCode

          public GlacierJobDescription withStatusCode(java.lang.String statusCode)

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

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

      Constraints:
      Allowed Values: InProgress, Succeeded, Failed

      パラメータ:
        `statusCode` - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      関連項目:
        `StatusCode`

    - #### setStatusCode

          public void setStatusCode(StatusCode statusCode)

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

      Constraints:
      Allowed Values: InProgress, Succeeded, Failed

      パラメータ:
        `statusCode` - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      関連項目:
        `StatusCode`

    - #### withStatusCode

          public GlacierJobDescription withStatusCode(StatusCode statusCode)

      The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

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

      Constraints:
      Allowed Values: InProgress, Succeeded, Failed

      パラメータ:
        `statusCode` - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
      関連項目:
        `StatusCode`

    - #### getStatusMessage

          public java.lang.String getStatusMessage()

      A friendly message that describes the job status.
      戻り値:
        A friendly message that describes the job status.

    - #### setStatusMessage

          public void setStatusMessage(java.lang.String statusMessage)

      A friendly message that describes the job status.
      パラメータ:
        `statusMessage` - A friendly message that describes the job status.

    - #### withStatusMessage

          public GlacierJobDescription withStatusMessage(java.lang.String statusMessage)

      A friendly message that describes the job status.

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

      パラメータ:
        `statusMessage` - A friendly message that describes the job status.

    - #### getArchiveSizeInBytes

          public java.lang.Long getArchiveSizeInBytes()

      For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.
      戻り値:
        For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

    - #### setArchiveSizeInBytes

          public void setArchiveSizeInBytes(java.lang.Long archiveSizeInBytes)

      For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.
      パラメータ:
        `archiveSizeInBytes` - For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

    - #### withArchiveSizeInBytes

          public GlacierJobDescription withArchiveSizeInBytes(java.lang.Long archiveSizeInBytes)

      For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

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

      パラメータ:
        `archiveSizeInBytes` - For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

    - #### getInventorySizeInBytes

          public java.lang.Long getInventorySizeInBytes()

      For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
      戻り値:
        For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

    - #### setInventorySizeInBytes

          public void setInventorySizeInBytes(java.lang.Long inventorySizeInBytes)

      For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.
      パラメータ:
        `inventorySizeInBytes` - For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

    - #### withInventorySizeInBytes

          public GlacierJobDescription withInventorySizeInBytes(java.lang.Long inventorySizeInBytes)

      For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

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

      パラメータ:
        `inventorySizeInBytes` - For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

    - #### getSNSTopic

          public java.lang.String getSNSTopic()

      An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
      戻り値:
        An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

    - #### setSNSTopic

          public void setSNSTopic(java.lang.String sNSTopic)

      An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
      パラメータ:
        `sNSTopic` - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

    - #### withSNSTopic

          public GlacierJobDescription withSNSTopic(java.lang.String sNSTopic)

      An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

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

      パラメータ:
        `sNSTopic` - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

    - #### getCompletionDate

          public java.lang.String getCompletionDate()

      The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
      戻り値:
        The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

    - #### setCompletionDate

          public void setCompletionDate(java.lang.String completionDate)

      The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
      パラメータ:
        `completionDate` - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

    - #### withCompletionDate

          public GlacierJobDescription withCompletionDate(java.lang.String completionDate)

      The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

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

      パラメータ:
        `completionDate` - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

    - #### getSHA256TreeHash

          public java.lang.String getSHA256TreeHash()

      For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
      戻り値:
        For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

    - #### setSHA256TreeHash

          public void setSHA256TreeHash(java.lang.String sHA256TreeHash)

      For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.
      パラメータ:
        `sHA256TreeHash` - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

    - #### withSHA256TreeHash

          public GlacierJobDescription withSHA256TreeHash(java.lang.String sHA256TreeHash)

      For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

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

      パラメータ:
        `sHA256TreeHash` - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

    - #### getArchiveSHA256TreeHash

          public java.lang.String getArchiveSHA256TreeHash()

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

    - #### setArchiveSHA256TreeHash

          public void setArchiveSHA256TreeHash(java.lang.String archiveSHA256TreeHash)

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

    - #### withArchiveSHA256TreeHash

          public GlacierJobDescription withArchiveSHA256TreeHash(java.lang.String archiveSHA256TreeHash)

      Sets the value of the ArchiveSHA256TreeHash property for this object.

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

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

    - #### getRetrievalByteRange

          public java.lang.String getRetrievalByteRange()

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

    - #### setRetrievalByteRange

          public void setRetrievalByteRange(java.lang.String retrievalByteRange)

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

    - #### withRetrievalByteRange

          public GlacierJobDescription withRetrievalByteRange(java.lang.String retrievalByteRange)

      Sets the value of the RetrievalByteRange property for this object.

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

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

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