com.ibm.cos.v2.auth.signer.params

Interface AwsS3V4SignerParams.Builder

All Superinterfaces:

Aws4SignerParams.Builder<AwsS3V4SignerParams.Builder>

Enclosing class:

AwsS3V4SignerParams

public static interface AwsS3V4SignerParams.Builder
extends Aws4SignerParams.Builder<AwsS3V4SignerParams.Builder>

Method Summary

Modifier and Type	Method and Description
AwsS3V4SignerParams	build()
AwsS3V4SignerParams.Builder	enableChunkedEncoding(Boolean enableChunkedEncoding) Configures the client to enable chunked encoding for all requests.
AwsS3V4SignerParams.Builder	enablePayloadSigning(Boolean enablePayloadSigning) Configures the client to sign payloads in all situations.

Methods inherited from interface com.ibm.cos.v2.auth.signer.params.Aws4SignerParams.Builder

awsCredentials, checksumParams, doubleUrlEncode, normalizePath, signingClockOverride, signingName, signingRegion, timeOffset

Method Detail

enableChunkedEncoding

AwsS3V4SignerParams.Builder enableChunkedEncoding(Boolean enableChunkedEncoding)

Configures the client to enable chunked encoding for all requests.

The default behavior is to enable chunked encoding automatically. Disable this flag will result in disabling chunked encoding for all requests.

Note: Disabling this option has performance implications since the checksum for the payload will have to be pre-calculated before sending the data. If your payload is large this will affect the overall time required to upload an object. Using this option is recommended only if your endpoint does not implement chunked uploading.

Parameters:

enableChunkedEncoding - True to enable chunked encoding and False to disable. Default value is True.

enablePayloadSigning

AwsS3V4SignerParams.Builder enablePayloadSigning(Boolean enablePayloadSigning)

Configures the client to sign payloads in all situations.

Payload signing is optional when chunked encoding is not used and requests are made against an HTTPS endpoint. Under these conditions the client will by default opt to not sign payloads to optimize performance. If this flag is set to true the client will instead always sign payloads.

Note: Payload signing can be expensive, particularly if transferring large payloads in a single chunk. Enabling this option will result in a performance penalty.

Parameters:

enablePayloadSigning - True to explicitly enable payload signing in all situations. Default value is False.

build

AwsS3V4SignerParams build()

Specified by:

build in interface Aws4SignerParams.Builder<AwsS3V4SignerParams.Builder>