com.ibm.cloud.objectstorage.client.builder

Class AwsAsyncClientBuilder<Subclass extends AwsAsyncClientBuilder,TypeToBuild>

java.lang.Object

com.ibm.cloud.objectstorage.client.builder.AwsClientBuilder<Subclass,TypeToBuild>

com.ibm.cloud.objectstorage.client.builder.AwsAsyncClientBuilder<Subclass,TypeToBuild>

Type Parameters:

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

@NotThreadSafe
public abstract class AwsAsyncClientBuilder<Subclass extends AwsAsyncClientBuilder,TypeToBuild>
extends AwsClientBuilder<Subclass,TypeToBuild>

Base class for all service specific async client builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AwsAsyncClientBuilder.AsyncBuilderParams Presents a view of the builder to be used in the async client constructor.

Nested classes/interfaces inherited from class com.ibm.cloud.objectstorage.client.builder.AwsClientBuilder

AwsClientBuilder.EndpointConfiguration, AwsClientBuilder.SyncBuilderParams

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsAsyncClientBuilder(ClientConfigurationFactory clientConfigFactory)
protected	AwsAsyncClientBuilder(ClientConfigurationFactory clientConfigFactory, AwsRegionProvider regionProvider)

Method Summary

Modifier and Type	Method and Description
TypeToBuild	build() Builds a client with the configure properties.
protected abstract TypeToBuild	build(AwsAsyncClientParams asyncClientParams)
protected AwsAsyncClientParams	getAsyncClientParams()
ExecutorFactory	getExecutorFactory()
void	setExecutorFactory(ExecutorFactory executorFactory) Sets a custom executor service factory to use for the async clients.
Subclass	withExecutorFactory(ExecutorFactory executorFactory) Sets a custom executor service factory to use for the async clients.

Methods inherited from class com.ibm.cloud.objectstorage.client.builder.AwsClientBuilder

getClientConfiguration, getCredentials, getEndpoint, getMetricsCollector, getRegion, getRequestHandlers, getSubclass, getSyncClientParams, setClientConfiguration, setCredentials, setEndpointConfiguration, setMetricsCollector, setRegion, setRequestHandlers, withClientConfiguration, withCredentials, withEndpointConfiguration, withIAMEndpoint, withIAMMaxRetry, withIAMTokenRefresh, withMetricsCollector, withRegion, withRegion, withRequestHandlers

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsAsyncClientBuilder

protected AwsAsyncClientBuilder(ClientConfigurationFactory clientConfigFactory)

AwsAsyncClientBuilder

protected AwsAsyncClientBuilder(ClientConfigurationFactory clientConfigFactory,
                                AwsRegionProvider regionProvider)

Method Detail

getExecutorFactory

public final ExecutorFactory getExecutorFactory()

Returns:

The ExecutorFactory currently configured by the client.

setExecutorFactory

public final void setExecutorFactory(ExecutorFactory executorFactory)

Sets a custom executor service factory to use for the async clients. The factory will be called for each async client created through the builder.

Parameters:

executorFactory - Factory supplying new instances of ExecutorService

withExecutorFactory

public final Subclass withExecutorFactory(ExecutorFactory executorFactory)

Sets a custom executor service factory to use for the async clients. The factory will be called for each async client created through the builder.

Parameters:

executorFactory - Factory supplying new instances of ExecutorService

Returns:

This object for method chaining.

build

public final TypeToBuild build()

Description copied from class: AwsClientBuilder

Builds a client with the configure properties.

Specified by:

build in class AwsClientBuilder<Subclass extends AwsAsyncClientBuilder,TypeToBuild>

Returns:

Client instance to make API calls with.

build

protected abstract TypeToBuild build(AwsAsyncClientParams asyncClientParams)

getAsyncClientParams

protected final AwsAsyncClientParams getAsyncClientParams()

Returns:

An instance of AwsAsyncClientParams that has all params to be used in the async client constructor.