Aws::Crt::S3::S3ChecksumConfig Class Reference

#include <S3.h>

Public Member Functions
	S3ChecksumConfig () noexcept
S3ChecksumConfig &	SetLocation (S3ChecksumLocation location) noexcept
S3ChecksumConfig &	SetChecksumAlgorithm (S3ChecksumAlgorithm algorithm) noexcept
S3ChecksumConfig &	SetValidateResponseChecksum (bool validate) noexcept
S3ChecksumLocation	GetLocation () const noexcept
S3ChecksumAlgorithm	GetChecksumAlgorithm () const noexcept
bool	GetValidateResponseChecksum () const noexcept

Detailed Description

Per-meta-request checksum configuration. The same object is used to describe request-side checksum calculation for uploads and response-side checksum validation for downloads; not every field applies in both directions.

Constructor & Destructor Documentation

S3ChecksumConfig()

Aws::Crt::S3::S3ChecksumConfig::S3ChecksumConfig ( )

noexcept

Member Function Documentation

GetChecksumAlgorithm()

S3ChecksumAlgorithm Aws::Crt::S3::S3ChecksumConfig::GetChecksumAlgorithm ( ) const

inlinenoexcept

Returns

the configured checksum algorithm.

GetLocation()

S3ChecksumLocation Aws::Crt::S3::S3ChecksumConfig::GetLocation ( ) const

inlinenoexcept

Returns

the configured wire location for the request-side checksum.

GetValidateResponseChecksum()

bool Aws::Crt::S3::S3ChecksumConfig::GetValidateResponseChecksum ( ) const

inlinenoexcept

Returns

whether response-side checksum validation is enabled.

SetChecksumAlgorithm()

S3ChecksumConfig & Aws::Crt::S3::S3ChecksumConfig::SetChecksumAlgorithm ( S3ChecksumAlgorithm  algorithm )

inlinenoexcept

Set the algorithm used to compute checksums for this request.

Parameters

algorithm

the checksum algorithm to use.

Returns

this object, to allow chaining.

SetLocation()

S3ChecksumConfig & Aws::Crt::S3::S3ChecksumConfig::SetLocation ( S3ChecksumLocation  location )

inlinenoexcept

Set where a calculated checksum will appear on the wire.

Parameters

location

the wire location for the request-side checksum.

Returns

this object, to allow chaining.

SetValidateResponseChecksum()

S3ChecksumConfig & Aws::Crt::S3::S3ChecksumConfig::SetValidateResponseChecksum ( bool  validate )

inlinenoexcept

Enable or disable validation of the response-side checksum. Only meaningful for downloads.

Parameters

validate

true to enable response checksum validation.

Returns

this object, to allow chaining.

---

The documentation for this class was generated from the following files:

• include/aws/crt/s3/S3.h
• source/s3/S3.cpp