com.ibm.cos.v2.services.s3

Interface S3BaseClientBuilder<B extends S3BaseClientBuilder<B,C>,C>

All Superinterfaces:

AwsClientBuilder<B,C>, Buildable, SdkBuilder<B,C>, SdkClientBuilder<B,C>

All Known Subinterfaces:

S3AsyncClientBuilder, S3ClientBuilder

@Generated(value="com.ibm.cos.v2:codegen")
public interface S3BaseClientBuilder<B extends S3BaseClientBuilder<B,C>,C>
extends AwsClientBuilder<B,C>

This includes configuration specific to Amazon S3 that is supported by both S3ClientBuilder and S3AsyncClientBuilder.

Method Summary

Modifier and Type	Method and Description
B	accelerate(Boolean accelerate) Enables this client to use S3 Transfer Acceleration endpoints.
default B	authSchemeProvider(S3AuthSchemeProvider authSchemeProvider) Set the S3AuthSchemeProvider implementation that will be used by the client to resolve the auth scheme for each request.
B	crossRegionAccessEnabled(Boolean crossRegionAccessEnabled) Enables cross-region bucket access for this client
B	disableMultiRegionAccessPoints(Boolean disableMultiRegionAccessPoints) Disables this client's usage of Multi-Region Access Points.
B	disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth) Disables this client's usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.
default B	endpointProvider(S3EndpointProvider endpointProvider) Set the S3EndpointProvider implementation that will be used by the client to determine the endpoint for each request.
B	forcePathStyle(Boolean forcePathStyle) Forces this client to use path-style addressing for buckets.
default B	requestChecksumCalculation(RequestChecksumCalculation requestChecksumCalculation) Configures the client behavior for request checksum calculation.
default B	responseChecksumValidation(ResponseChecksumValidation responseChecksumValidation) Configures the client behavior for response checksum validation.
default B	serviceConfiguration(Consumer<S3Configuration.Builder> serviceConfiguration)
B	serviceConfiguration(S3Configuration serviceConfiguration)
default B	sigv4aSigningRegionSet(RegionSet sigv4aSigningRegionSet) Sets the RegionSet to be used for operations using Sigv4a signing requests.
B	useArnRegion(Boolean useArnRegion) Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.

Methods inherited from interface com.ibm.cos.v2.awscore.client.builder.AwsClientBuilder

credentialsProvider, credentialsProvider, defaultsMode, dualstackEnabled, fipsEnabled, region

Methods inherited from interface com.ibm.cos.v2.core.client.builder.SdkClientBuilder

addPlugin, endpointOverride, iamEndpoint, overrideConfiguration, overrideConfiguration, overrideConfiguration, plugins, putAuthScheme

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

serviceConfiguration

B serviceConfiguration(S3Configuration serviceConfiguration)

serviceConfiguration

default B serviceConfiguration(Consumer<S3Configuration.Builder> serviceConfiguration)

endpointProvider

default B endpointProvider(S3EndpointProvider endpointProvider)

Set the S3EndpointProvider implementation that will be used by the client to determine the endpoint for each request. This is optional; if none is provided a default implementation will be used the SDK.

authSchemeProvider

default B authSchemeProvider(S3AuthSchemeProvider authSchemeProvider)

Set the S3AuthSchemeProvider implementation that will be used by the client to resolve the auth scheme for each request. This is optional; if none is provided a default implementation will be used the SDK.

accelerate

B accelerate(Boolean accelerate)

Enables this client to use S3 Transfer Acceleration endpoints.

disableMultiRegionAccessPoints

B disableMultiRegionAccessPoints(Boolean disableMultiRegionAccessPoints)

Disables this client's usage of Multi-Region Access Points.

disableS3ExpressSessionAuth

B disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)

Disables this client's usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.

forcePathStyle

B forcePathStyle(Boolean forcePathStyle)

Forces this client to use path-style addressing for buckets.

useArnRegion

B useArnRegion(Boolean useArnRegion)

Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.

crossRegionAccessEnabled

B crossRegionAccessEnabled(Boolean crossRegionAccessEnabled)

Enables cross-region bucket access for this client

requestChecksumCalculation

default B requestChecksumCalculation(RequestChecksumCalculation requestChecksumCalculation)

Configures the client behavior for request checksum calculation.

responseChecksumValidation

default B responseChecksumValidation(ResponseChecksumValidation responseChecksumValidation)

Configures the client behavior for response checksum validation.

sigv4aSigningRegionSet

default B sigv4aSigningRegionSet(RegionSet sigv4aSigningRegionSet)

Sets the RegionSet to be used for operations using Sigv4a signing requests. This is optional; if not provided, the following precedence is used:

1. SdkSystemSetting.AWS_SIGV4A_SIGNING_REGION_SET.
2. as sigv4a_signing_region_set in the configuration file.
3. The region configured for the client.