Java com.amazonaws ClientConfiguration fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for com.amazonaws ClientConfiguration.

The text is from its open source code.

Field

int	DEFAULT_CONNECTION_TIMEOUT The default timeout for creating new connections.
int	DEFAULT_SOCKET_TIMEOUT The default timeout for reading from a connected socket.
int	DEFAULT_MAX_CONNECTIONS The default max connection pool size.
String	DEFAULT_USER_AGENT The default HTTP user agent header for AWS Java SDK clients.
RetryPolicy	DEFAULT_RETRY_POLICY Default request retry policy, including the maximum retry count of 3, the default retry condition and the default back-off strategy.
boolean	DEFAULT_USE_REAPER The default on whether to use the IdleConnectionReaper to manage stale connections
boolean	DEFAULT_USE_GZIP The default on whether to use gzip compression.
long	DEFAULT_CONNECTION_TTL The default expiration time (in milliseconds) for a connection in the connection pool.
boolean	DEFAULT_TCP_KEEP_ALIVE The default on whether to use TCP KeepAlive.

Constructor

	ClientConfiguration()
	ClientConfiguration(ClientConfiguration other)

Method

ApacheHttpClientConfig	getApacheHttpClientConfig() Returns a non-null object that can be used to specify Apache HTTP client specific custom configurations.
int	getConnectionTimeout() Returns the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
int	getMaxErrorRetry() Returns the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from a service).
Protocol	getProtocol() Returns the protocol (HTTP or HTTPS) to use when connecting to Amazon Web Services.
String	getProxyDomain() Returns the optional Windows domain name for configuring an NTLM proxy.
String	getProxyHost() Returns the optional proxy host the client will connect through.
String	getProxyPassword() Returns the optional proxy password to use if connecting through a proxy.
int	getProxyPort() Returns the optional proxy port the client will connect through.
String	getProxyUsername() Returns the optional proxy user name to use if connecting through a proxy.
String	getProxyWorkstation() Returns the optional Windows workstation name for configuring NTLM proxy support.
int[]	getSocketBufferSizeHints() Returns the optional size hints (in bytes) for the low level TCP send and receive buffers.
int	getSocketTimeout() Returns the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
String	getUserAgent()
boolean	isPreemptiveBasicProxyAuth() Returns whether to attempt to authenticate preemptively against proxy servers using basic authentication
void	setClientExecutionTimeout(int clientExecutionTimeout) Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
void	setConnectionTimeout(int connectionTimeout) Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
void	setConnectionTTL(long connectionTTL) Sets the expiration time (in milliseconds) for a connection in the connection pool.
void	setLocalAddress(InetAddress localAddress) Sets the optional local address the client will bind to.
void	setMaxConnections(int maxConnections) Sets the maximum number of allowed open HTTP connections.
void	setMaxErrorRetry(int maxErrorRetry) Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services).
void	setNonProxyHosts(String nonProxyHosts) Set the optional hosts the client will access without going through the proxy.
void	setPreemptiveBasicProxyAuth(Boolean preemptiveBasicProxyAuth) Sets whether to attempt to authenticate preemptively against proxy servers using basic authentication
void	setProtocol(Protocol protocol) Sets the protocol (i.e.
void	setProxyDomain(String proxyDomain) Sets the optional Windows domain name for configuration an NTLM proxy.
void	setProxyHost(String proxyHost) Sets the optional proxy host the client will connect through.
void	setProxyPassword(String proxyPassword) Sets the optional proxy password to use when connecting through a proxy.
void	setProxyPort(int proxyPort) Sets the optional proxy port the client will connect through.
void	setProxyUsername(String proxyUsername) Sets the optional proxy user name to use if connecting through a proxy.
void	setProxyWorkstation(String proxyWorkstation) Sets the optional Windows workstation name for configuring NTLM proxy support.
void	setRequestTimeout(int requestTimeout) Sets the amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
void	setResponseMetadataCacheSize(int responseMetadataCacheSize) Sets the response metadata cache size.
void	setRetryPolicy(RetryPolicy retryPolicy) Sets the retry policy upon failed requests.
void	setSignerOverride(final String value) Sets the name of the signature algorithm to use for signing requests made by this client.
void	setSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint) Sets the optional size hints (in bytes) for the low level TCP send and receive buffers.
void	setSocketTimeout(int socketTimeout) Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
void	setUseGzip(boolean use) Sets whether gzip compression should be used
void	setUserAgent(String userAgent)
void	setUserAgentPrefix(String prefix) Sets the HTTP user agent prefix to send with all requests.
void	setUseReaper(boolean use) Sets whether the IdleConnectionReaper is to be started as a daemon thread
void	setUseTcpKeepAlive(final boolean use) Sets whether or not to enable TCP KeepAlive support at the socket level.
void	setUseThrottleRetries(boolean use) Sets whether throttled retries should be used Retry throttling is a feature which intelligently throttles retry attempts when a large percentage of requests are failing and retries are unsuccessful, particularly in scenarios of degraded service health.
ClientConfiguration	withClientExecutionTimeout(int clientExecutionTimeout) Sets the amount of time (in milliseconds) to allow the client to complete the execution of an API call.
ClientConfiguration	withConnectionTimeout(int connectionTimeout) Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out, and returns the updated ClientConfiguration object so that additional method calls may be chained together.
ClientConfiguration	withMaxConnections(int maxConnections) Sets the maximum number of allowed open HTTP connections and returns the updated ClientConfiguration object.
ClientConfiguration	withMaxErrorRetry(int maxErrorRetry) Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error responses from services), and returns the updated ClientConfiguration object.
ClientConfiguration	withProtocol(Protocol protocol) Sets the protocol (i.e.
ClientConfiguration	withProxyHost(String proxyHost) Sets the optional proxy host the client will connect through and returns the updated ClientConfiguration object.
ClientConfiguration	withProxyPassword(String proxyPassword) Sets the optional proxy password to use when connecting through a proxy, and returns the updated ClientConfiguration object.
ClientConfiguration	withProxyPort(int proxyPort) Sets the optional proxy port the client will connect through and returns the updated ClientConfiguration object.
ClientConfiguration	withProxyUsername(String proxyUsername) Sets the optional proxy user name and returns the updated ClientConfiguration object.
ClientConfiguration	withRetryPolicy(RetryPolicy retryPolicy) Sets the retry policy upon failed requests, and returns the updated ClientConfiguration object.
ClientConfiguration	withSignerOverride(final String value) Sets the name of the signature algorithm to use for signing requests made by this client.
ClientConfiguration	withSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint) Sets the optional size hints (in bytes) for the low level TCP send and receive buffers, and returns the updated ClientConfiguration object so that additional method calls may be chained together.
ClientConfiguration	withSocketTimeout(int socketTimeout) Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed, and returns the updated ClientConfiguration object so that additional method calls may be chained together.
ClientConfiguration	withUseExpectContinue(boolean useExpectContinue) Sets if use expect continue should be enabled.
ClientConfiguration	withUserAgentPrefix(String prefix) Sets the HTTP user agent prefix header used in requests and returns the updated ClientConfiguration object.