Package software.amazon.awssdk.client.builder

Class AwsClientBuilder<SubclassT extends AwsClientBuilder,TypeToBuildT>

java.lang.Object

software.amazon.awssdk.client.builder.AwsClientBuilder<SubclassT,TypeToBuildT>

Type Parameters:

SubclassT - Concrete builder type, used for better fluent methods.

TypeToBuildT - Type that this builder builds.

Direct Known Subclasses:

AwsAsyncClientBuilder, AwsSyncClientBuilder

@NotThreadSafe
public abstract class AwsClientBuilder<SubclassT extends AwsClientBuilder,TypeToBuildT>
extends Object

Base class for all service specific client builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AwsClientBuilder.EndpointConfiguration	A container for configuration required to submit requests to a service (service endpoint and signing region)

Method Summary

Modifier and Type	Method	Description
abstract TypeToBuildT	build()	Builds a client with the configure properties.
LegacyClientConfiguration	getClientConfiguration()	Gets the ClientConfiguration currently configured in the builder
AwsCredentialsProvider	getCredentials()	Gets the AWSCredentialsProvider currently configured in the builder.
AwsClientBuilder.EndpointConfiguration	getEndpoint()	Gets the service endpointConfiguration in use by the builder
abstract String	getEndpointPrefix()
RequestMetricCollector	getMetricsCollector()	Gets the RequestMetricCollector in use by the builder.
String	getRegion()	Gets the region in use by the builder.
List<RequestHandler>	getRequestHandlers()	Gets the list of request handlers in use by the builder.
abstract String	getServiceName()
void	setClientConfiguration(LegacyClientConfiguration config)	Sets the ClientConfiguration to be used by the client.
void	setCredentials(AwsCredentialsProvider credentialsProvider)	Sets the AWSCredentialsProvider used by the client.
void	setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)	Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
void	setMetricsCollector(RequestMetricCollector metrics)	Sets a custom RequestMetricCollector to use for the client.
void	setRegion(String region)	Sets the region to be used by the client.
void	setRequestHandlers(RequestHandler... handlers)	Sets the request handlers to use in the client.
SubclassT	withClientConfiguration(LegacyClientConfiguration config)	Sets the ClientConfiguration to be used by the client.
SubclassT	withCredentials(AwsCredentialsProvider credentialsProvider)	Sets the AWSCredentialsProvider used by the client.
SubclassT	withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)	Sets the endpoint configuration (service endpoint & signing region) to be used for requests.
SubclassT	withMetricsCollector(RequestMetricCollector metrics)	Sets a custom RequestMetricCollector to use for the client.
SubclassT	withRegion(Region region)	Sets the region to be used by the client.
SubclassT	withRequestHandlers(RequestHandler... handlers)	Sets the request handlers to use in the client.

Methods inherited from class java.lang.Object

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

Method Detail

getCredentials

public final AwsCredentialsProvider getCredentials()

Gets the AWSCredentialsProvider currently configured in the builder.

setCredentials

public final void setCredentials(AwsCredentialsProvider credentialsProvider)

Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultCredentialsProvider.

Parameters:

credentialsProvider - New AWSCredentialsProvider to use.

withCredentials

public final SubclassT withCredentials(AwsCredentialsProvider credentialsProvider)

Sets the AWSCredentialsProvider used by the client. If not specified the default is DefaultCredentialsProvider.

Parameters:

credentialsProvider - New AWSCredentialsProvider to use.

Returns:

This object for method chaining.

getClientConfiguration

public final LegacyClientConfiguration getClientConfiguration()

Gets the ClientConfiguration currently configured in the builder

setClientConfiguration

public final void setClientConfiguration(LegacyClientConfiguration config)

Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedLegacyClientConfigurations#defaultConfig but may differ per service.

Parameters:

config - Custom configuration to use

withClientConfiguration

public final SubclassT withClientConfiguration(LegacyClientConfiguration config)

Sets the ClientConfiguration to be used by the client. If not specified the default is typically PredefinedLegacyClientConfigurations#defaultConfig but may differ per service.

Parameters:

config - Custom configuration to use

Returns:

This object for method chaining.

getMetricsCollector

public final RequestMetricCollector getMetricsCollector()

Gets the RequestMetricCollector in use by the builder.

setMetricsCollector

public final void setMetricsCollector(RequestMetricCollector metrics)

Sets a custom RequestMetricCollector to use for the client.

Parameters:

metrics - Custom RequestMetricCollector to use.

withMetricsCollector

public final SubclassT withMetricsCollector(RequestMetricCollector metrics)

Sets a custom RequestMetricCollector to use for the client.

Parameters:

metrics - Custom RequestMetricCollector to use.

Returns:

This object for method chaining.

getRegion

public final String getRegion()

Gets the region in use by the builder.

setRegion

public final void setRegion(String region)

Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.

Parameters:

region - Region to use

withRegion

public SubclassT withRegion(Region region)

Sets the region to be used by the client. This will be used to determine both the service endpoint (eg: https://sns.us-west-1.amazonaws.com) and signing region (eg: us-west-1) for requests. If neither region or endpoint configuration setEndpointConfiguration(EndpointConfiguration) are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.

Parameters:

region - Region to use, this will be used to determine both service endpoint and the signing region

Returns:

This object for method chaining.

getEndpoint

public final AwsClientBuilder.EndpointConfiguration getEndpoint()

Gets the service endpointConfiguration in use by the builder

setEndpointConfiguration

public final void setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region setRegion(String) or endpoint configuration are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.

Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use setRegion(String)

Parameters:

endpointConfiguration - The endpointConfiguration to use

withEndpointConfiguration

public final SubclassT withEndpointConfiguration(AwsClientBuilder.EndpointConfiguration endpointConfiguration)

Sets the endpoint configuration (service endpoint & signing region) to be used for requests. If neither region withRegion(Region) or endpoint configuration are explicitly provided in the builder the DEFAULT_REGION_PROVIDER is consulted.

Only use this if using a non-standard service endpoint - the recommended approach for configuring a client is to use withRegion(Region)

Parameters:

endpointConfiguration - The endpointConfiguration to use

Returns:

This object for method chaining.

getRequestHandlers

public final List<RequestHandler> getRequestHandlers()

Gets the list of request handlers in use by the builder.

setRequestHandlers

public final void setRequestHandlers(RequestHandler... handlers)

Sets the request handlers to use in the client.

Parameters:

handlers - Request handlers to use for client.

withRequestHandlers

public final SubclassT withRequestHandlers(RequestHandler... handlers)

Sets the request handlers to use in the client.

Parameters:

handlers - Request handlers to use for client.

Returns:

This object for method chaining.

build

public abstract TypeToBuildT build()

Builds a client with the configure properties.

Returns:

Client instance to make API calls with.

getServiceName

public abstract String getServiceName()

getEndpointPrefix

public abstract String getEndpointPrefix()