com.ibm.cos.v2.services.s3.auth.scheme

Interface S3AuthSchemeParams

All Superinterfaces:

ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>

All Known Implementing Classes:

DefaultS3AuthSchemeParams

@Generated(value="com.ibm.cos.v2:codegen")
public interface S3AuthSchemeParams
extends ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>

The parameters object used to resolve the auth schemes for the S3 service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	S3AuthSchemeParams.Builder A builder for a S3AuthSchemeParams.

Method Summary

Modifier and Type	Method and Description
Boolean	accelerate() When true, use S3 Accelerate.
String	bucket() The S3 bucket used to send the request.
static S3AuthSchemeParams.Builder	builder() Get a new builder for creating a S3AuthSchemeParams.
String	copySource() The Copy Source used for Copy Object request.
List<String>	deleteObjectKeys() DeleteObjectKeys Endpoint Params from the customization config
Boolean	disableAccessPoints() Internal parameter to disable Access Point Buckets
Boolean	disableMultiRegionAccessPoints() Whether multi-region access points (MRAP) should be disabled.
Boolean	disableS3ExpressSessionAuth() Parameter to indicate whether S3Express session auth should be disabled
String	endpoint() Override the endpoint used to send this request
Boolean	forcePathStyle() When true, force a path-style endpoint to be used where the bucket name is part of the path.
String	key() The S3 Key used to send the request.
String	operation() Returns the operation for which to resolve the auth scheme.
String	prefix() The S3 Prefix used to send the request.
Region	region() Returns the region.
RegionSet	regionSet() Returns the RegionSet.
S3AuthSchemeParams.Builder	toBuilder() Returns a S3AuthSchemeParams.Builder to customize the parameters.
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.
Boolean	useDualStack() When true, use the dual-stack endpoint.
Boolean	useFips() When true, send this request to the FIPS-compliant regional endpoint.
Boolean	useGlobalEndpoint() Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
Boolean	useObjectLambdaEndpoint() Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
Boolean	useS3ExpressControlEndpoint() Internal parameter to indicate whether S3Express operation should use control plane, (ex.

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

copy

Method Detail

builder

static S3AuthSchemeParams.Builder builder()

Get a new builder for creating a S3AuthSchemeParams.

operation

String operation()

Returns the operation for which to resolve the auth scheme.

region

Region region()

Returns the region. The region parameter may be used with the "aws.auth#sigv4" auth scheme.

regionSet

RegionSet regionSet()

Returns the RegionSet. The regionSet parameter may be used with the "aws.auth#sigv4a" auth scheme.

bucket

String bucket()

The S3 bucket used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 bucket.

useFips

Boolean useFips()

When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.

useDualStack

Boolean useDualStack()

When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.

endpoint

String endpoint()

Override the endpoint used to send this request

forcePathStyle

Boolean forcePathStyle()

When true, force a path-style endpoint to be used where the bucket name is part of the path.

accelerate

Boolean accelerate()

When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.

useGlobalEndpoint

Boolean useGlobalEndpoint()

Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.

useObjectLambdaEndpoint

Boolean useObjectLambdaEndpoint()

Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)

key

String key()

The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key.

prefix

String prefix()

The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix.

copySource

String copySource()

The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source.

disableAccessPoints

Boolean disableAccessPoints()

Internal parameter to disable Access Point Buckets

disableMultiRegionAccessPoints

Boolean disableMultiRegionAccessPoints()

Whether multi-region access points (MRAP) should be disabled.

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.

useS3ExpressControlEndpoint

Boolean useS3ExpressControlEndpoint()

Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)

disableS3ExpressSessionAuth

Boolean disableS3ExpressSessionAuth()

Parameter to indicate whether S3Express session auth should be disabled

deleteObjectKeys

List<String> deleteObjectKeys()

DeleteObjectKeys Endpoint Params from the customization config

toBuilder

S3AuthSchemeParams.Builder toBuilder()

Returns a S3AuthSchemeParams.Builder to customize the parameters.

Specified by:

toBuilder in interface ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>

Returns:

a builder for type T