Package software.amazon.awssdk.crt.s3

Class S3MetaRequestOptions

java.lang.Object

software.amazon.awssdk.crt.s3.S3MetaRequestOptions

public class S3MetaRequestOptions
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	S3MetaRequestOptions.MetaRequestType	A Meta Request represents a group of generated requests that are being done on behalf of the original request.

Constructor Summary

Constructors

Constructor	Description
S3MetaRequestOptions()

Method Summary

Modifier and Type	Method	Description
ChecksumAlgorithm	getChecksumAlgorithm()	Deprecated.
ChecksumConfig	getChecksumConfig()
CredentialsProvider	getCredentialsProvider()
URI	getEndpoint()
HttpRequest	getHttpRequest()
S3MetaRequestOptions.MetaRequestType	getMetaRequestType()
S3MetaRequestResponseHandler	getResponseHandler()
ResumeToken	getResumeToken()
boolean	getValidateChecksum()	Deprecated.
S3MetaRequestOptions	withChecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)	Deprecated. Please use withChecksumConfig(ChecksumConfig) instead.
S3MetaRequestOptions	withChecksumConfig(ChecksumConfig checksumConfig)	The config related to checksum used for the meta request.
S3MetaRequestOptions	withCredentialsProvider(CredentialsProvider credentialsProvider)
S3MetaRequestOptions	withEndpoint(URI endpoint)
S3MetaRequestOptions	withHttpRequest(HttpRequest httpRequest)
S3MetaRequestOptions	withMetaRequestType(S3MetaRequestOptions.MetaRequestType metaRequestType)
S3MetaRequestOptions	withResponseHandler(S3MetaRequestResponseHandler responseHandler)
S3MetaRequestOptions	withResumeToken(ResumeToken resumeToken)
S3MetaRequestOptions	withValidateChecksum(boolean validateChecksum)	Deprecated. Please use withChecksumConfig(ChecksumConfig) instead.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

S3MetaRequestOptions

public S3MetaRequestOptions()

Method Detail

withMetaRequestType

public S3MetaRequestOptions withMetaRequestType(S3MetaRequestOptions.MetaRequestType metaRequestType)

getMetaRequestType

public S3MetaRequestOptions.MetaRequestType getMetaRequestType()

withChecksumConfig

public S3MetaRequestOptions withChecksumConfig(ChecksumConfig checksumConfig)

The config related to checksum used for the meta request. See ChecksumConfig for details.

Parameters:

checksumConfig - The checksum config used for the meta request

Returns:

this

getChecksumConfig

public ChecksumConfig getChecksumConfig()

withChecksumAlgorithm

public S3MetaRequestOptions withChecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

Deprecated.

Please use withChecksumConfig(ChecksumConfig) instead. Specify the checksum algorithm to use use for put requests, if unset defaults to NONE and no checksum will be calculated. The location of the checksum will be default to trailer.

Parameters:

checksumAlgorithm - the checksum algorithm to use use for put requests

Returns:

this

getChecksumAlgorithm

public ChecksumAlgorithm getChecksumAlgorithm()

Deprecated.

Returns:

the checksum algorithm to use use for put requests

withValidateChecksum

public S3MetaRequestOptions withValidateChecksum(boolean validateChecksum)

Deprecated.

Please use withChecksumConfig(ChecksumConfig) instead. validateChecksum defaults to false, if set to true, it will cause the client to compare a streamed calculation of the objects checksum to a remotely stored checksum assigned to the object if one exists. The checksumValidated field passed in parameter of the finished callback will inform the user if validation ocurred. A mismatch will result in a AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH error

Parameters:

validateChecksum - Validate the checksum of response if server provides.

Returns:

this

getValidateChecksum

public boolean getValidateChecksum()

Deprecated.

Returns:

Validate the checksum of response if server provides.

withHttpRequest

public S3MetaRequestOptions withHttpRequest(HttpRequest httpRequest)

getHttpRequest

public HttpRequest getHttpRequest()

withResponseHandler

public S3MetaRequestOptions withResponseHandler(S3MetaRequestResponseHandler responseHandler)

getResponseHandler

public S3MetaRequestResponseHandler getResponseHandler()

withCredentialsProvider

public S3MetaRequestOptions withCredentialsProvider(CredentialsProvider credentialsProvider)

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

withEndpoint

public S3MetaRequestOptions withEndpoint(URI endpoint)

getEndpoint

public URI getEndpoint()

withResumeToken

public S3MetaRequestOptions withResumeToken(ResumeToken resumeToken)

getResumeToken

public ResumeToken getResumeToken()