Class GetJobOutputResult

java.lang.Object
com.amazonaws.services.glacier.model.GetJobOutputResult
All Implemented Interfaces:
Serializable, Cloneable

public class GetJobOutputResult extends Object implements Serializable, Cloneable

Contains the Amazon Glacier response to your request.

See Also:
  • Constructor Details

    • GetJobOutputResult

      public GetJobOutputResult()
  • Method Details

    • setBody

      public void setBody(InputStream body)

      The job data, either archive data or inventory data.

      Parameters:
      body - The job data, either archive data or inventory data.
    • getBody

      public InputStream getBody()

      The job data, either archive data or inventory data.

      Returns:
      The job data, either archive data or inventory data.
    • withBody

      public GetJobOutputResult withBody(InputStream body)

      The job data, either archive data or inventory data.

      Parameters:
      body - The job data, either archive data or inventory data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setChecksum

      public void setChecksum(String checksum)

      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

      Parameters:
      checksum - The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:
      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
    • getChecksum

      public String getChecksum()

      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

      Returns:
      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:
      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
    • withChecksum

      public GetJobOutputResult withChecksum(String checksum)

      The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

      Parameters:
      checksum - The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:
      • You get the entire range of the archive.
      • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.
      • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatus

      public void setStatus(Integer status)

      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

      Parameters:
      status - The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
    • getStatus

      public Integer getStatus()

      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

      Returns:
      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
    • withStatus

      public GetJobOutputResult withStatus(Integer status)

      The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

      Parameters:
      status - The HTTP response code for a job output request. The value depends on whether a range was specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setContentRange

      public void setContentRange(String contentRange)

      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

      Parameters:
      contentRange - The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
    • getContentRange

      public String getContentRange()

      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

      Returns:
      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
    • withContentRange

      public GetJobOutputResult withContentRange(String contentRange)

      The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

      Parameters:
      contentRange - The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setAcceptRanges

      public void setAcceptRanges(String acceptRanges)

      Indicates the range units accepted. For more information, go to RFC2616.

      Parameters:
      acceptRanges - Indicates the range units accepted. For more information, go to RFC2616 .
    • getAcceptRanges

      public String getAcceptRanges()

      Indicates the range units accepted. For more information, go to RFC2616.

      Returns:
      Indicates the range units accepted. For more information, go to RFC2616.
    • withAcceptRanges

      public GetJobOutputResult withAcceptRanges(String acceptRanges)

      Indicates the range units accepted. For more information, go to RFC2616.

      Parameters:
      acceptRanges - Indicates the range units accepted. For more information, go to RFC2616 .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setContentType

      public void setContentType(String contentType)

      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

      Parameters:
      contentType - The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.
    • getContentType

      public String getContentType()

      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

      Returns:
      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.
    • withContentType

      public GetJobOutputResult withContentType(String contentType)

      The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

      Parameters:
      contentType - The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setArchiveDescription

      public void setArchiveDescription(String archiveDescription)

      The description of an archive.

      Parameters:
      archiveDescription - The description of an archive.
    • getArchiveDescription

      public String getArchiveDescription()

      The description of an archive.

      Returns:
      The description of an archive.
    • withArchiveDescription

      public GetJobOutputResult withArchiveDescription(String archiveDescription)

      The description of an archive.

      Parameters:
      archiveDescription - The description of an archive.
      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public GetJobOutputResult clone()
      Overrides:
      clone in class Object