com.ibm.cos.v2.services.s3

Interface S3Configuration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<S3Configuration.Builder,S3Configuration>, SdkBuilder<S3Configuration.Builder,S3Configuration>

Enclosing class:

S3Configuration

@NotThreadSafe
public static interface S3Configuration.Builder
extends CopyableBuilder<S3Configuration.Builder,S3Configuration>

Method Summary

Modifier and Type	Method and Description
Boolean	accelerateModeEnabled()
S3Configuration.Builder	accelerateModeEnabled(Boolean accelerateModeEnabled) Option to enable using the accelerate endpoint when accessing S3.
Boolean	checksumValidationEnabled() Deprecated. This option has been replaced with S3BaseClientBuilder.requestChecksumCalculation(RequestChecksumCalculation) and S3BaseClientBuilder.responseChecksumValidation(ResponseChecksumValidation). If both this and one of those options are set, an exception will be thrown.
S3Configuration.Builder	checksumValidationEnabled(Boolean checksumValidationEnabled) Deprecated. This option has been replaced with S3BaseClientBuilder.requestChecksumCalculation(RequestChecksumCalculation) and S3BaseClientBuilder.responseChecksumValidation(ResponseChecksumValidation). If both this and one of those options are set, an exception will be thrown.
Boolean	chunkedEncodingEnabled()
S3Configuration.Builder	chunkedEncodingEnabled(Boolean chunkedEncodingEnabled) Option to enable using chunked encoding when signing the request payload for PutObjectRequest and UploadPartRequest.
Boolean	dualstackEnabled()
S3Configuration.Builder	dualstackEnabled(Boolean dualstackEnabled) Deprecated. This option has been replaced with AwsClientBuilder.dualstackEnabled(Boolean) and S3Presigner.Builder#dualstackEnabled(Boolean). If both this and one of those options are set, an exception will be thrown.
Boolean	multiRegionEnabled()
S3Configuration.Builder	multiRegionEnabled(Boolean multiRegionEnabled) Option to enable or disable the usage of multi-region access point ARNs.
Boolean	pathStyleAccessEnabled()
S3Configuration.Builder	pathStyleAccessEnabled(Boolean pathStyleAccessEnabled) Option to enable using path style access for accessing S3 objects instead of DNS style access.
ProfileFile	profileFile()
S3Configuration.Builder	profileFile(ProfileFile profileFile) The profile file that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean).
S3Configuration.Builder	profileFile(Supplier<ProfileFile> profileFile) The supplier of profile file instances that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean).
Supplier<ProfileFile>	profileFileSupplier()
String	profileName()
S3Configuration.Builder	profileName(String profileName) The profile name that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean).
Boolean	useArnRegionEnabled()
S3Configuration.Builder	useArnRegionEnabled(Boolean useArnRegionEnabled) If an S3 resource ARN is passed in as the target of an S3 operation that has a different region to the one the client was configured with, this flag must be set to 'true' to permit the client to make a cross-region call to the region specified in the ARN otherwise an exception will be thrown.

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

copy

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

applyMutation, build

Method Detail

dualstackEnabled

Boolean dualstackEnabled()

dualstackEnabled

@Deprecated
S3Configuration.Builder dualstackEnabled(Boolean dualstackEnabled)

Deprecated. This option has been replaced with AwsClientBuilder.dualstackEnabled(Boolean) and S3Presigner.Builder#dualstackEnabled(Boolean). If both this and one of those options are set, an exception will be thrown.

Option to enable using the dualstack endpoints when accessing S3. Dualstack should be enabled if you want to use IPv6.

Dualstack endpoints are disabled by default.

accelerateModeEnabled

Boolean accelerateModeEnabled()

accelerateModeEnabled

S3Configuration.Builder accelerateModeEnabled(Boolean accelerateModeEnabled)

Option to enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations.

Accelerate mode is disabled by default.

See Also:

S3Configuration.accelerateModeEnabled().

pathStyleAccessEnabled

Boolean pathStyleAccessEnabled()

pathStyleAccessEnabled

S3Configuration.Builder pathStyleAccessEnabled(Boolean pathStyleAccessEnabled)

Option to enable using path style access for accessing S3 objects instead of DNS style access. DNS style access is preferred as it will result in better load balancing when accessing S3.

Path style access is disabled by default. Path style may still be used for legacy buckets that are not DNS compatible.

See Also:

S3Configuration.pathStyleAccessEnabled().

checksumValidationEnabled

@Deprecated
Boolean checksumValidationEnabled()

Deprecated. This option has been replaced with S3BaseClientBuilder.requestChecksumCalculation(RequestChecksumCalculation) and S3BaseClientBuilder.responseChecksumValidation(ResponseChecksumValidation). If both this and one of those options are set, an exception will be thrown.

checksumValidationEnabled

@Deprecated
S3Configuration.Builder checksumValidationEnabled(Boolean checksumValidationEnabled)

Deprecated. This option has been replaced with S3BaseClientBuilder.requestChecksumCalculation(RequestChecksumCalculation) and S3BaseClientBuilder.responseChecksumValidation(ResponseChecksumValidation). If both this and one of those options are set, an exception will be thrown.

Option to disable MD5 trailing checksum validation of an object stored in S3. This is enabled by default.

The recommended approach is to specify a ChecksumAlgorithm on the PutObjectRequest and enable ChecksumMode on the GetObjectRequest. In that case, validation will be performed for the specified flexible checksum, and validation will not be performed for MD5 checksum.

For PutObjectRequest, MD5 trailing checksum validation will be performed if:

• Checksum validation is not disabled
• Server-side encryption is not used
• Flexible checksum algorithm is not specified

For GetObjectRequest, MD5 trailing checksum validation will be performed if:

• Checksum validation is not disabled
• ChecksumMode is disabled (default)
• Regular S3 is used (non-S3Express)

See Also:

S3Configuration.checksumValidationEnabled().

chunkedEncodingEnabled

Boolean chunkedEncodingEnabled()

chunkedEncodingEnabled

S3Configuration.Builder chunkedEncodingEnabled(Boolean chunkedEncodingEnabled)

Option to enable using chunked encoding when signing the request payload for PutObjectRequest and UploadPartRequest.

See Also:

S3Configuration.chunkedEncodingEnabled()

useArnRegionEnabled

Boolean useArnRegionEnabled()

useArnRegionEnabled

S3Configuration.Builder useArnRegionEnabled(Boolean useArnRegionEnabled)

If an S3 resource ARN is passed in as the target of an S3 operation that has a different region to the one the client was configured with, this flag must be set to 'true' to permit the client to make a cross-region call to the region specified in the ARN otherwise an exception will be thrown.

See Also:

S3Configuration.useArnRegionEnabled()

multiRegionEnabled

Boolean multiRegionEnabled()

multiRegionEnabled

S3Configuration.Builder multiRegionEnabled(Boolean multiRegionEnabled)

Option to enable or disable the usage of multi-region access point ARNs. Multi-region access point ARNs can result in cross-region calls, and can be prevented by setting this flag to false. This option is enabled by default.

See Also:

S3Configuration.multiRegionEnabled()

profileFile

ProfileFile profileFile()

profileFile

S3Configuration.Builder profileFile(ProfileFile profileFile)

The profile file that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean). This is not used, if those parameters are configured.

By default, the ProfileFile.defaultProfileFile() is used.

profileFileSupplier

Supplier<ProfileFile> profileFileSupplier()

profileFile

S3Configuration.Builder profileFile(Supplier<ProfileFile> profileFile)

The supplier of profile file instances that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean). This is not used, if those parameters are configured on the builder.

By default, the ProfileFile.defaultProfileFile() is used.

profileName

String profileName()

profileName

S3Configuration.Builder profileName(String profileName)

The profile name that should be consulted to determine the default value of useArnRegionEnabled(Boolean) or multiRegionEnabled(Boolean). This is not used, if those parameters are configured.

By default, the ProfileFileSystemSetting.AWS_PROFILE is used.