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
com.amazonaws.auth.AWSCredentialsProvider	getCredentialSet()
String	getEndpoint()
Map<String,String>	getHeaders() Get the map of headers.
StatisticsFromAwsSdk	getMetrics()
com.amazonaws.monitoring.MonitoringListener	getMonitoringListener()
List<com.amazonaws.handlers.RequestHandler2>	getRequestHandlers() List of request handlers to include in the chain of request execution in the SDK.
String	getUserAgentSuffix()
boolean	isPathStyleAccess()
boolean	isRequesterPays()
S3ClientFactory.S3ClientCreationParameters	withCredentialSet(com.amazonaws.auth.AWSCredentialsProvider value) Set credentials.
S3ClientFactory.S3ClientCreationParameters	withEndpoint(String value) Set endpoint.
S3ClientFactory.S3ClientCreationParameters	withHeader(String header, String value) Add a custom header.
S3ClientFactory.S3ClientCreationParameters	withMetrics(StatisticsFromAwsSdk statistics) Metrics binding.
S3ClientFactory.S3ClientCreationParameters	withMonitoringListener(com.amazonaws.monitoring.MonitoringListener listener) listener for AWS monitoring events.
S3ClientFactory.S3ClientCreationParameters	withPathStyleAccess(boolean value) Set path access option.
S3ClientFactory.S3ClientCreationParameters	withRequesterPays(boolean value) Requester pays option.
S3ClientFactory.S3ClientCreationParameters	withRequestHandlers(List<com.amazonaws.handlers.RequestHandler2> handlers) List of request handlers.
S3ClientFactory.S3ClientCreationParameters	withUserAgentSuffix(String value) Set UA suffix.

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ClientCreationParameters

public S3ClientCreationParameters()

Method Detail

getRequestHandlers

public List<com.amazonaws.handlers.RequestHandler2> getRequestHandlers()

List of request handlers to include in the chain of request execution in the SDK.

Returns:

the handler list

withRequestHandlers

public S3ClientFactory.S3ClientCreationParameters withRequestHandlers(@Nullable
                                                                      List<com.amazonaws.handlers.RequestHandler2> handlers)

List of request handlers.

Parameters:

handlers - handler list.

Returns:

this object

getMonitoringListener

public com.amazonaws.monitoring.MonitoringListener getMonitoringListener()

withMonitoringListener

public S3ClientFactory.S3ClientCreationParameters withMonitoringListener(@Nullable
                                                                         com.amazonaws.monitoring.MonitoringListener listener)

listener for AWS monitoring events.

Parameters:

listener - listener

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)

Requester pays option. Not yet wired up.

Parameters:

value - new value

Returns:

the builder

isRequesterPays

public boolean isRequesterPays()

getCredentialSet

public com.amazonaws.auth.AWSCredentialsProvider getCredentialSet()

withCredentialSet

public S3ClientFactory.S3ClientCreationParameters withCredentialSet(com.amazonaws.auth.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