| Package | Description |
|---|---|
| com.ibm.cos.v2.services.s3.auth.scheme | |
| com.ibm.cos.v2.services.s3.auth.scheme.internal |
| Modifier and Type | Method and Description |
|---|---|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.accelerate(Boolean accelerate)
When true, use S3 Accelerate.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.bucket(String bucket)
The S3 bucket used to send the request.
|
static S3AuthSchemeParams.Builder |
S3AuthSchemeParams.builder()
Get a new builder for creating a
S3AuthSchemeParams. |
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.copySource(String copySource)
The Copy Source used for Copy Object request.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.deleteObjectKeys(List<String> deleteObjectKeys)
DeleteObjectKeys Endpoint Params from the customization config
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.disableAccessPoints(Boolean disableAccessPoints)
Internal parameter to disable Access Point Buckets
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.disableMultiRegionAccessPoints(Boolean disableMultiRegionAccessPoints)
Whether multi-region access points (MRAP) should be disabled.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)
Parameter to indicate whether S3Express session auth should be disabled
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.endpoint(String endpoint)
Override the endpoint used to send this request
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.forcePathStyle(Boolean forcePathStyle)
When true, force a path-style endpoint to be used where the bucket name is part of the path.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.key(String key)
The S3 Key used to send the request.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.operation(String operation)
Set the operation for which to resolve the auth scheme.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.prefix(String prefix)
The S3 Prefix used to send the request.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.region(Region region)
Set the region.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.regionSet(RegionSet regionSet)
Set the RegionSet.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.toBuilder()
Returns a
S3AuthSchemeParams.Builder to customize the parameters. |
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useArnRegion(Boolean useArnRegion)
When an Access Point ARN is provided and this flag is enabled, the SDK MUST use the ARN's region when
constructing the endpoint instead of the client's configured region.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useDualStack(Boolean useDualStack)
When true, use the dual-stack endpoint.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useFips(Boolean useFIPS)
When true, send this request to the FIPS-compliant regional endpoint.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useGlobalEndpoint(Boolean useGlobalEndpoint)
Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useObjectLambdaEndpoint(Boolean useObjectLambdaEndpoint)
Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
|
S3AuthSchemeParams.Builder |
S3AuthSchemeParams.Builder.useS3ExpressControlEndpoint(Boolean useS3ExpressControlEndpoint)
Internal parameter to indicate whether S3Express operation should use control plane, (ex.
|
| Modifier and Type | Method and Description |
|---|---|
default List<AuthSchemeOption> |
S3AuthSchemeProvider.resolveAuthScheme(Consumer<S3AuthSchemeParams.Builder> consumer)
Resolve the auth schemes based on the given set of parameters.
|
| Modifier and Type | Method and Description |
|---|---|
static S3AuthSchemeParams.Builder |
DefaultS3AuthSchemeParams.builder() |
S3AuthSchemeParams.Builder |
DefaultS3AuthSchemeParams.toBuilder() |
Copyright © 2026. All rights reserved.