Package software.amazon.awssdk.services.glacier.model

Interface GetJobOutputResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>, GlacierResponse.Builder, SdkBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetJobOutputResponse
public static interface GetJobOutputResponse.Builder extends GlacierResponse.Builder, SdkPojo, CopyableBuilder<GetJobOutputResponse.Builder,GetJobOutputResponse>

  • Method Details

    • checksum

      GetJobOutputResponse.Builder checksum(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.

    • status

      GetJobOutputResponse.Builder status(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.

    • contentRange

      GetJobOutputResponse.Builder contentRange(String contentRange)

      The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 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 S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 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.

    • acceptRanges

      GetJobOutputResponse.Builder acceptRanges(String acceptRanges)

      Indicates the range units accepted. For more information, see RFC2616.

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

    • contentType

      GetJobOutputResponse.Builder contentType(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.

    • archiveDescription

      GetJobOutputResponse.Builder archiveDescription(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.