Class GlacierJobDescription

    • Constructor Detail

      • GlacierJobDescription

        public GlacierJobDescription()
    • Method Detail

      • setJobId

        public void setJobId​(String jobId)

        An opaque string that identifies an Amazon Glacier job.

        Parameters:
        jobId - An opaque string that identifies an Amazon Glacier job.
      • getJobId

        public String getJobId()

        An opaque string that identifies an Amazon Glacier job.

        Returns:
        An opaque string that identifies an Amazon Glacier job.
      • withJobId

        public GlacierJobDescription withJobId​(String jobId)

        An opaque string that identifies an Amazon Glacier job.

        Parameters:
        jobId - An opaque string that identifies an Amazon Glacier job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setJobDescription

        public void setJobDescription​(String jobDescription)

        The job description you provided when you initiated the job.

        Parameters:
        jobDescription - The job description you provided when you initiated the job.
      • getJobDescription

        public String getJobDescription()

        The job description you provided when you initiated the job.

        Returns:
        The job description you provided when you initiated the job.
      • withJobDescription

        public GlacierJobDescription withJobDescription​(String jobDescription)

        The job description you provided when you initiated the job.

        Parameters:
        jobDescription - The job description you provided when you initiated the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAction

        public void setAction​(String action)

        The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        Parameters:
        action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
        See Also:
        ActionCode
      • getAction

        public String getAction()

        The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        Returns:
        The job type. It is either ArchiveRetrieval or InventoryRetrieval.
        See Also:
        ActionCode
      • withAction

        public GlacierJobDescription withAction​(String action)

        The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        Parameters:
        action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionCode
      • setAction

        public void setAction​(ActionCode action)

        The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        Parameters:
        action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
        See Also:
        ActionCode
      • withAction

        public GlacierJobDescription withAction​(ActionCode action)

        The job type. It is either ArchiveRetrieval or InventoryRetrieval.

        Parameters:
        action - The job type. It is either ArchiveRetrieval or InventoryRetrieval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionCode
      • setArchiveId

        public void setArchiveId​(String archiveId)

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

        Parameters:
        archiveId - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
      • getArchiveId

        public String getArchiveId()

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

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

        public GlacierJobDescription withArchiveId​(String archiveId)

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

        Parameters:
        archiveId - For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setVaultARN

        public void setVaultARN​(String vaultARN)

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

        Parameters:
        vaultARN - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
      • getVaultARN

        public String getVaultARN()

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

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

        public GlacierJobDescription withVaultARN​(String vaultARN)

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

        Parameters:
        vaultARN - The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCreationDate

        public void setCreationDate​(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".

        Parameters:
        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".
      • getCreationDate

        public 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".

        Returns:
        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​(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".

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setCompleted

        public void setCompleted​(Boolean completed)

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

        Parameters:
        completed - The job status. When a job is completed, you get the job's output.
      • getCompleted

        public Boolean getCompleted()

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

        Returns:
        The job status. When a job is completed, you get the job's output.
      • withCompleted

        public GlacierJobDescription withCompleted​(Boolean completed)

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

        Parameters:
        completed - The job status. When a job is completed, you get the job's output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isCompleted

        public Boolean isCompleted()

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

        Returns:
        The job status. When a job is completed, you get the job's output.
      • setStatusCode

        public void setStatusCode​(String statusCode)

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

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        See Also:
        StatusCode
      • getStatusCode

        public String getStatusCode()

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

        Returns:
        The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        See Also:
        StatusCode
      • withStatusCode

        public GlacierJobDescription withStatusCode​(String statusCode)

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

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusCode
      • setStatusCode

        public void setStatusCode​(StatusCode statusCode)

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

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        See Also:
        StatusCode
      • withStatusCode

        public GlacierJobDescription withStatusCode​(StatusCode statusCode)

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

        Parameters:
        statusCode - The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        StatusCode
      • setStatusMessage

        public void setStatusMessage​(String statusMessage)

        A friendly message that describes the job status.

        Parameters:
        statusMessage - A friendly message that describes the job status.
      • getStatusMessage

        public String getStatusMessage()

        A friendly message that describes the job status.

        Returns:
        A friendly message that describes the job status.
      • withStatusMessage

        public GlacierJobDescription withStatusMessage​(String statusMessage)

        A friendly message that describes the job status.

        Parameters:
        statusMessage - A friendly message that describes the job status.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setArchiveSizeInBytes

        public void setArchiveSizeInBytes​(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.

        Parameters:
        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.
      • getArchiveSizeInBytes

        public 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.

        Returns:
        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​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setInventorySizeInBytes

        public void setInventorySizeInBytes​(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.

        Parameters:
        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.
      • getInventorySizeInBytes

        public 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.

        Returns:
        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​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setSNSTopic

        public void setSNSTopic​(String sNSTopic)

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

        Parameters:
        sNSTopic - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
      • getSNSTopic

        public String getSNSTopic()

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

        Returns:
        An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
      • withSNSTopic

        public GlacierJobDescription withSNSTopic​(String sNSTopic)

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

        Parameters:
        sNSTopic - An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCompletionDate

        public void setCompletionDate​(String completionDate)

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

        Parameters:
        completionDate - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
      • getCompletionDate

        public String getCompletionDate()

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

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

        public GlacierJobDescription withCompletionDate​(String completionDate)

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

        Parameters:
        completionDate - The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSHA256TreeHash

        public void setSHA256TreeHash​(String sHA256TreeHash)

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

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

        Parameters:
        sHA256TreeHash - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

      • getSHA256TreeHash

        public String getSHA256TreeHash()

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

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

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

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

      • withSHA256TreeHash

        public GlacierJobDescription withSHA256TreeHash​(String sHA256TreeHash)

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

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

        Parameters:
        sHA256TreeHash - For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

        The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

        For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

        This field is null in the following situations:

        • Archive retrieval jobs that specify a range that is not tree-hash aligned.

        • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

        • Inventory jobs.

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

        public void setArchiveSHA256TreeHash​(String archiveSHA256TreeHash)

        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

        Parameters:
        archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
      • getArchiveSHA256TreeHash

        public String getArchiveSHA256TreeHash()

        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

        Returns:
        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
      • withArchiveSHA256TreeHash

        public GlacierJobDescription withArchiveSHA256TreeHash​(String archiveSHA256TreeHash)

        The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

        Parameters:
        archiveSHA256TreeHash - The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRetrievalByteRange

        public void setRetrievalByteRange​(String retrievalByteRange)

        The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

        Parameters:
        retrievalByteRange - The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
      • getRetrievalByteRange

        public String getRetrievalByteRange()

        The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

        Returns:
        The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
      • withRetrievalByteRange

        public GlacierJobDescription withRetrievalByteRange​(String retrievalByteRange)

        The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

        Parameters:
        retrievalByteRange - The retrieved byte range for archive retrieval jobs in the form "StartByteValue-EndByteValue" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setInventoryRetrievalParameters

        public void setInventoryRetrievalParameters​(InventoryRetrievalJobDescription inventoryRetrievalParameters)

        Parameters used for range inventory retrieval.

        Parameters:
        inventoryRetrievalParameters - Parameters used for range inventory retrieval.
      • getInventoryRetrievalParameters

        public InventoryRetrievalJobDescription getInventoryRetrievalParameters()

        Parameters used for range inventory retrieval.

        Returns:
        Parameters used for range inventory retrieval.
      • withInventoryRetrievalParameters

        public GlacierJobDescription withInventoryRetrievalParameters​(InventoryRetrievalJobDescription inventoryRetrievalParameters)

        Parameters used for range inventory retrieval.

        Parameters:
        inventoryRetrievalParameters - Parameters used for range inventory retrieval.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object