DefaultS3AuthSchemeParams (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.services.s3.auth.scheme.internal.DefaultS3AuthSchemeParams

All Implemented Interfaces:: S3EndpointResolverAware, S3AuthSchemeParams, ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>

@Generated(value="com.ibm.cos.v2:codegen")
public final class DefaultS3AuthSchemeParams
extends Object
implements S3AuthSchemeParams, S3EndpointResolverAware

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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
`S3EndpointProvider`	`endpointProvider()`
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Method Detail
  - builder
```
public static S3AuthSchemeParams.Builder builder()
```
    Description copied from interface: S3AuthSchemeParams
    
    Get a new builder for creating a S3AuthSchemeParams.
    
    Specified by:
    
    builder in interface S3AuthSchemeParams
  - operation
```
public String operation()
```
    Description copied from interface: S3AuthSchemeParams
    
    Returns the operation for which to resolve the auth scheme.
    
    Specified by:
    
    operation in interface S3AuthSchemeParams
  - region
```
public Region region()
```
    Description copied from interface: S3AuthSchemeParams
    
    Returns the region. The region parameter may be used with the "aws.auth#sigv4" auth scheme.
    
    Specified by:
    
    region in interface S3AuthSchemeParams
  - regionSet
```
public RegionSet regionSet()
```
    Description copied from interface: S3AuthSchemeParams
    
    Returns the RegionSet. The regionSet parameter may be used with the "aws.auth#sigv4a" auth scheme.
    
    Specified by:
    
    regionSet in interface S3AuthSchemeParams
  - bucket
```
public String bucket()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    bucket in interface S3AuthSchemeParams
  - useFips
```
public Boolean useFips()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    useFips in interface S3AuthSchemeParams
  - useDualStack
```
public Boolean useDualStack()
```
    Description copied from interface: S3AuthSchemeParams
    
    When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
    
    Specified by:
    
    useDualStack in interface S3AuthSchemeParams
  - endpoint
```
public String endpoint()
```
    Description copied from interface: S3AuthSchemeParams
    
    Override the endpoint used to send this request
    
    Specified by:
    
    endpoint in interface S3AuthSchemeParams
  - forcePathStyle
```
public Boolean forcePathStyle()
```
    Description copied from interface: S3AuthSchemeParams
    
    When true, force a path-style endpoint to be used where the bucket name is part of the path.
    
    Specified by:
    
    forcePathStyle in interface S3AuthSchemeParams
  - accelerate
```
public Boolean accelerate()
```
    Description copied from interface: S3AuthSchemeParams
    
    When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate.
    
    Specified by:
    
    accelerate in interface S3AuthSchemeParams
  - useGlobalEndpoint
```
public Boolean useGlobalEndpoint()
```
    Description copied from interface: S3AuthSchemeParams
    
    Whether the global endpoint should be used, rather then the regional endpoint for us-east-1.
    
    Specified by:
    
    useGlobalEndpoint in interface S3AuthSchemeParams
  - useObjectLambdaEndpoint
```
public Boolean useObjectLambdaEndpoint()
```
    Description copied from interface: S3AuthSchemeParams
    
    Internal parameter to use object lambda endpoint for an operation (eg: WriteGetObjectResponse)
    
    Specified by:
    
    useObjectLambdaEndpoint in interface S3AuthSchemeParams
  - key
```
public String key()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    key in interface S3AuthSchemeParams
  - prefix
```
public String prefix()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    prefix in interface S3AuthSchemeParams
  - copySource
```
public String copySource()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    copySource in interface S3AuthSchemeParams
  - disableAccessPoints
```
public Boolean disableAccessPoints()
```
    Description copied from interface: S3AuthSchemeParams
    
    Internal parameter to disable Access Point Buckets
    
    Specified by:
    
    disableAccessPoints in interface S3AuthSchemeParams
  - disableMultiRegionAccessPoints
```
public Boolean disableMultiRegionAccessPoints()
```
    Description copied from interface: S3AuthSchemeParams
    
    Whether multi-region access points (MRAP) should be disabled.
    
    Specified by:
    
    disableMultiRegionAccessPoints in interface S3AuthSchemeParams
  - useArnRegion
```
public Boolean useArnRegion()
```
    Description copied from interface: S3AuthSchemeParams
    
    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.
    
    Specified by:
    
    useArnRegion in interface S3AuthSchemeParams
  - useS3ExpressControlEndpoint
```
public Boolean useS3ExpressControlEndpoint()
```
    Description copied from interface: S3AuthSchemeParams
    
    Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket)
    
    Specified by:
    
    useS3ExpressControlEndpoint in interface S3AuthSchemeParams
  - disableS3ExpressSessionAuth
```
public Boolean disableS3ExpressSessionAuth()
```
    Description copied from interface: S3AuthSchemeParams
    
    Parameter to indicate whether S3Express session auth should be disabled
    
    Specified by:
    
    disableS3ExpressSessionAuth in interface S3AuthSchemeParams
  - deleteObjectKeys
```
public List<String> deleteObjectKeys()
```
    Description copied from interface: S3AuthSchemeParams
    
    DeleteObjectKeys Endpoint Params from the customization config
    
    Specified by:
    
    deleteObjectKeys in interface S3AuthSchemeParams
  - endpointProvider
```
public S3EndpointProvider endpointProvider()
```
    Specified by:
    
    endpointProvider in interface S3EndpointResolverAware
  - toBuilder
```
public S3AuthSchemeParams.Builder toBuilder()
```
    Description copied from interface: S3AuthSchemeParams
    
    Returns a S3AuthSchemeParams.Builder to customize the parameters.
    
    Specified by:
    
    toBuilder in interface S3AuthSchemeParams
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3AuthSchemeParams.Builder,S3AuthSchemeParams>
    
    Returns:
    
    a builder for type T

Class DefaultS3AuthSchemeParams

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

builder

operation

region

regionSet

bucket

useFips

useDualStack

endpoint

forcePathStyle

accelerate

useGlobalEndpoint

useObjectLambdaEndpoint

key

prefix

copySource

disableAccessPoints

disableMultiRegionAccessPoints

useArnRegion

useS3ExpressControlEndpoint

disableS3ExpressSessionAuth

deleteObjectKeys

endpointProvider

toBuilder