/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Glacier { namespace Model { /** *

Contains the Amazon S3 Glacier response to your request.

See * Also:

AWS * API Reference

*/ class GetJobOutputResult { public: AWS_GLACIER_API GetJobOutputResult(); //We have to define these because Microsoft doesn't auto generate them AWS_GLACIER_API GetJobOutputResult(GetJobOutputResult&&); AWS_GLACIER_API GetJobOutputResult& operator=(GetJobOutputResult&&); //we delete these because Microsoft doesn't handle move generation correctly //and we therefore don't trust them to get it right here either. GetJobOutputResult(const GetJobOutputResult&) = delete; GetJobOutputResult& operator=(const GetJobOutputResult&) = delete; AWS_GLACIER_API GetJobOutputResult(Aws::AmazonWebServiceResult&& result); AWS_GLACIER_API GetJobOutputResult& operator=(Aws::AmazonWebServiceResult&& result); /** *

The job data, either archive data or inventory data.

*/ inline Aws::IOStream& GetBody() const { return m_body.GetUnderlyingStream(); } /** *

The job data, either archive data or inventory data.

*/ inline void ReplaceBody(Aws::IOStream* body) { m_body = Aws::Utils::Stream::ResponseStream(body); } /** *

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.

*/ inline const Aws::String& GetChecksum() const{ return m_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.

*/ inline void SetChecksum(const Aws::String& value) { m_checksum = value; } /** *

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.

*/ inline void SetChecksum(Aws::String&& value) { m_checksum = std::move(value); } /** *

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.

*/ inline void SetChecksum(const char* value) { m_checksum.assign(value); } /** *

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.

*/ inline GetJobOutputResult& WithChecksum(const Aws::String& value) { SetChecksum(value); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithChecksum(Aws::String&& value) { SetChecksum(std::move(value)); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithChecksum(const char* value) { SetChecksum(value); return *this;} /** *

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

*/ inline int GetStatus() const{ return m_status; } /** *

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

*/ inline void SetStatus(int value) { m_status = value; } /** *

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

*/ inline GetJobOutputResult& WithStatus(int value) { SetStatus(value); return *this;} /** *

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.

*/ inline const Aws::String& GetContentRange() const{ return m_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.

*/ inline void SetContentRange(const Aws::String& value) { m_contentRange = value; } /** *

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.

*/ inline void SetContentRange(Aws::String&& value) { m_contentRange = std::move(value); } /** *

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.

*/ inline void SetContentRange(const char* value) { m_contentRange.assign(value); } /** *

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.

*/ inline GetJobOutputResult& WithContentRange(const Aws::String& value) { SetContentRange(value); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithContentRange(Aws::String&& value) { SetContentRange(std::move(value)); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithContentRange(const char* value) { SetContentRange(value); return *this;} /** *

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

*/ inline const Aws::String& GetAcceptRanges() const{ return m_acceptRanges; } /** *

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

*/ inline void SetAcceptRanges(const Aws::String& value) { m_acceptRanges = value; } /** *

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

*/ inline void SetAcceptRanges(Aws::String&& value) { m_acceptRanges = std::move(value); } /** *

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

*/ inline void SetAcceptRanges(const char* value) { m_acceptRanges.assign(value); } /** *

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

*/ inline GetJobOutputResult& WithAcceptRanges(const Aws::String& value) { SetAcceptRanges(value); return *this;} /** *

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

*/ inline GetJobOutputResult& WithAcceptRanges(Aws::String&& value) { SetAcceptRanges(std::move(value)); return *this;} /** *

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

*/ inline GetJobOutputResult& WithAcceptRanges(const char* value) { SetAcceptRanges(value); return *this;} /** *

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.

*/ inline const Aws::String& GetContentType() const{ return m_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.

*/ inline void SetContentType(const Aws::String& value) { m_contentType = value; } /** *

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.

*/ inline void SetContentType(Aws::String&& value) { m_contentType = std::move(value); } /** *

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.

*/ inline void SetContentType(const char* value) { m_contentType.assign(value); } /** *

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.

*/ inline GetJobOutputResult& WithContentType(const Aws::String& value) { SetContentType(value); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithContentType(Aws::String&& value) { SetContentType(std::move(value)); return *this;} /** *

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.

*/ inline GetJobOutputResult& WithContentType(const char* value) { SetContentType(value); return *this;} /** *

The description of an archive.

*/ inline const Aws::String& GetArchiveDescription() const{ return m_archiveDescription; } /** *

The description of an archive.

*/ inline void SetArchiveDescription(const Aws::String& value) { m_archiveDescription = value; } /** *

The description of an archive.

*/ inline void SetArchiveDescription(Aws::String&& value) { m_archiveDescription = std::move(value); } /** *

The description of an archive.

*/ inline void SetArchiveDescription(const char* value) { m_archiveDescription.assign(value); } /** *

The description of an archive.

*/ inline GetJobOutputResult& WithArchiveDescription(const Aws::String& value) { SetArchiveDescription(value); return *this;} /** *

The description of an archive.

*/ inline GetJobOutputResult& WithArchiveDescription(Aws::String&& value) { SetArchiveDescription(std::move(value)); return *this;} /** *

The description of an archive.

*/ inline GetJobOutputResult& WithArchiveDescription(const char* value) { SetArchiveDescription(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline GetJobOutputResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline GetJobOutputResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline GetJobOutputResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::Utils::Stream::ResponseStream m_body; Aws::String m_checksum; int m_status; Aws::String m_contentRange; Aws::String m_acceptRanges; Aws::String m_contentType; Aws::String m_archiveDescription; Aws::String m_requestId; }; } // namespace Model } // namespace Glacier } // namespace Aws