org.apache.hadoop.fs.s3a

Class S3ClientFactory.S3ClientCreationParameters

java.lang.Object

org.apache.hadoop.fs.s3a.S3ClientFactory.S3ClientCreationParameters

Enclosing interface:

S3ClientFactory

public static final class S3ClientFactory.S3ClientCreationParameters
extends Object

Settings for the S3 Client. Implemented as a class to pass in so that adding new parameters does not break the binding of external implementations of the factory.

Constructor Summary

Constructors

Constructor and Description
S3ClientCreationParameters()

Method Summary

Modifier and Type	Method and Description
software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getCredentialSet()
String	getEndpoint()
List<software.amazon.awssdk.core.interceptor.ExecutionInterceptor>	getExecutionInterceptors() List of execution interceptors to include in the chain of interceptors in the SDK.
Map<String,String>	getHeaders() Get the map of headers.
StatisticsFromAwsSdk	getMetrics()
long	getMinimumPartSize() Get the minimum part size for transfer parts.
long	getMultiPartThreshold() Get the threshold for multipart operations.
URI	getPathUri() Get the full s3 path.
String	getRegion() Get the region.
Executor	getTransferManagerExecutor() Get the executor that the transfer manager will use to execute background tasks.
String	getUserAgentSuffix()
boolean	isChecksumValidationEnabled()
boolean	isExpressCreateSession() Should s3express createSession be called?
boolean	isFipsEnabled() Get the FIPS flag.
boolean	isMultipartCopy() Get the multipart flag.
boolean	isPathStyleAccess()
boolean	isRequesterPays()
String	toString()
S3ClientFactory.S3ClientCreationParameters	withChecksumValidationEnabled(boolean value) Set builder value.
S3ClientFactory.S3ClientCreationParameters	withCredentialSet(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider value) Set credentials.
S3ClientFactory.S3ClientCreationParameters	withEndpoint(String value) Set endpoint.
S3ClientFactory.S3ClientCreationParameters	withExecutionInterceptors(List<software.amazon.awssdk.core.interceptor.ExecutionInterceptor> interceptors) List of execution interceptors.
S3ClientFactory.S3ClientCreationParameters	withExpressCreateSession(boolean value) Set builder value.
S3ClientFactory.S3ClientCreationParameters	withFipsEnabled(boolean value) Set builder value.
S3ClientFactory.S3ClientCreationParameters	withHeader(String header, String value) Add a custom header.
S3ClientFactory.S3ClientCreationParameters	withMetrics(StatisticsFromAwsSdk statistics) Metrics binding.
S3ClientFactory.S3ClientCreationParameters	withMinimumPartSize(long value) Set the minimum part size for transfer parts.
S3ClientFactory.S3ClientCreationParameters	withMultipartCopyEnabled(boolean value) Set the multipart flag..
S3ClientFactory.S3ClientCreationParameters	withMultipartThreshold(long value) Set the threshold for multipart operations.
S3ClientFactory.S3ClientCreationParameters	withPathStyleAccess(boolean value) Set path access option.
S3ClientFactory.S3ClientCreationParameters	withPathUri(URI value) Set full s3a path.
S3ClientFactory.S3ClientCreationParameters	withRegion(String value) Set region.
S3ClientFactory.S3ClientCreationParameters	withRequesterPays(boolean value) Set requester pays option.
S3ClientFactory.S3ClientCreationParameters	withTransferManagerExecutor(Executor value) Set the executor that the transfer manager will use to execute background tasks.
S3ClientFactory.S3ClientCreationParameters	withUserAgentSuffix(String value) Set UA suffix.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

S3ClientCreationParameters

public S3ClientCreationParameters()

Method Detail

getExecutionInterceptors

public List<software.amazon.awssdk.core.interceptor.ExecutionInterceptor> getExecutionInterceptors()

List of execution interceptors to include in the chain of interceptors in the SDK.

Returns:

the interceptors list

withExecutionInterceptors

public S3ClientFactory.S3ClientCreationParameters withExecutionInterceptors(@Nullable
                                                                            List<software.amazon.awssdk.core.interceptor.ExecutionInterceptor> interceptors)

List of execution interceptors.

Parameters:

interceptors - interceptors list.

Returns:

this object

getMetrics

public StatisticsFromAwsSdk getMetrics()

withMetrics

public S3ClientFactory.S3ClientCreationParameters withMetrics(@Nullable
                                                              StatisticsFromAwsSdk statistics)

Metrics binding. This is the S3A-level statistics interface, which will be wired up to the AWS callbacks.

Parameters:

statistics - statistics implementation

Returns:

this object

withRequesterPays

public S3ClientFactory.S3ClientCreationParameters withRequesterPays(boolean value)

Set requester pays option.

Parameters:

value - new value

Returns:

the builder

isRequesterPays

public boolean isRequesterPays()

getCredentialSet

public software.amazon.awssdk.auth.credentials.AwsCredentialsProvider getCredentialSet()

withCredentialSet

public S3ClientFactory.S3ClientCreationParameters withCredentialSet(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider value)

Set credentials.

Parameters:

value - new value

Returns:

the builder

getUserAgentSuffix

public String getUserAgentSuffix()

withUserAgentSuffix

public S3ClientFactory.S3ClientCreationParameters withUserAgentSuffix(String value)

Set UA suffix.

Parameters:

value - new value

Returns:

the builder

getEndpoint

public String getEndpoint()

withEndpoint

public S3ClientFactory.S3ClientCreationParameters withEndpoint(String value)

Set endpoint.

Parameters:

value - new value

Returns:

the builder

isPathStyleAccess

public boolean isPathStyleAccess()

withPathStyleAccess

public S3ClientFactory.S3ClientCreationParameters withPathStyleAccess(boolean value)

Set path access option.

Parameters:

value - new value

Returns:

the builder

withHeader

public S3ClientFactory.S3ClientCreationParameters withHeader(String header,
                                                             String value)

Add a custom header.

Parameters:

header - header name

value - new value

Returns:

the builder

getHeaders

public Map<String,String> getHeaders()

Get the map of headers.

Returns:

(mutable) header map

getPathUri

public URI getPathUri()

Get the full s3 path. added in HADOOP-18330

Returns:

path URI

withPathUri

public S3ClientFactory.S3ClientCreationParameters withPathUri(URI value)

Set full s3a path. added in HADOOP-18330

Parameters:

value - new value

Returns:

the builder

getMinimumPartSize

public long getMinimumPartSize()

Get the minimum part size for transfer parts.

Returns:

part size

withMinimumPartSize

public S3ClientFactory.S3ClientCreationParameters withMinimumPartSize(long value)

Set the minimum part size for transfer parts.

Parameters:

value - new value

Returns:

the builder

getMultiPartThreshold

public long getMultiPartThreshold()

Get the threshold for multipart operations.

Returns:

multipart threshold

withMultipartThreshold

public S3ClientFactory.S3ClientCreationParameters withMultipartThreshold(long value)

Set the threshold for multipart operations.

Parameters:

value - new value

Returns:

the builder

getTransferManagerExecutor

public Executor getTransferManagerExecutor()

Get the executor that the transfer manager will use to execute background tasks.

Returns:

part size

withTransferManagerExecutor

public S3ClientFactory.S3ClientCreationParameters withTransferManagerExecutor(Executor value)

Set the executor that the transfer manager will use to execute background tasks.

Parameters:

value - new value

Returns:

the builder

withMultipartCopyEnabled

public S3ClientFactory.S3ClientCreationParameters withMultipartCopyEnabled(boolean value)

Set the multipart flag..

Parameters:

value - new value

Returns:

the builder

isMultipartCopy

public boolean isMultipartCopy()

Get the multipart flag.

Returns:

multipart flag

withRegion

public S3ClientFactory.S3ClientCreationParameters withRegion(String value)

Set region.

Parameters:

value - new value

Returns:

the builder

getRegion

public String getRegion()

Get the region.

Returns:

invoker

isExpressCreateSession

public boolean isExpressCreateSession()

Should s3express createSession be called?

Returns:

true if the client should enable createSession.

withExpressCreateSession

public S3ClientFactory.S3ClientCreationParameters withExpressCreateSession(boolean value)

Set builder value.

Parameters:

value - new value

Returns:

the builder

withChecksumValidationEnabled

public S3ClientFactory.S3ClientCreationParameters withChecksumValidationEnabled(boolean value)

Set builder value.

Parameters:

value - new value

Returns:

the builder

isChecksumValidationEnabled

public boolean isChecksumValidationEnabled()

toString

public String toString()

Overrides:

toString in class Object

isFipsEnabled

public boolean isFipsEnabled()

Get the FIPS flag.

Returns:

is fips enabled

withFipsEnabled

public S3ClientFactory.S3ClientCreationParameters withFipsEnabled(boolean value)

Set builder value.

Parameters:

value - new value

Returns:

the builder