software.amazon.awssdk.core.client.builder

Interface AsyncClientBuilder<B extends AsyncClientBuilder<B,C>,C>

Type Parameters:

B - The type of builder that should be returned by the fluent builder methods in this interface.

C - The type of client generated by this builder.

All Superinterfaces:

ClientBuilder<B,C>, SdkBuilder<B,C>

All Known Subinterfaces:

ACMAsyncClientBuilder, AlexaForBusinessAsyncClientBuilder, APIGatewayAsyncClientBuilder, ApplicationAutoScalingAsyncClientBuilder, ApplicationDiscoveryAsyncClientBuilder, AppStreamAsyncClientBuilder, AppSyncAsyncClientBuilder, AthenaAsyncClientBuilder, AutoScalingAsyncClientBuilder, BatchAsyncClientBuilder, BudgetsAsyncClientBuilder, Cloud9AsyncClientBuilder, CloudDirectoryAsyncClientBuilder, CloudFormationAsyncClientBuilder, CloudFrontAsyncClientBuilder, CloudHSMAsyncClientBuilder, CloudHSMV2AsyncClientBuilder, CloudSearchAsyncClientBuilder, CloudSearchDomainAsyncClientBuilder, CloudTrailAsyncClientBuilder, CloudWatchAsyncClientBuilder, CloudWatchEventsAsyncClientBuilder, CloudWatchLogsAsyncClientBuilder, CodeBuildAsyncClientBuilder, CodeCommitAsyncClientBuilder, CodeDeployAsyncClientBuilder, CodePipelineAsyncClientBuilder, CodeStarAsyncClientBuilder, CognitoIdentityAsyncClientBuilder, CognitoIdentityProviderAsyncClientBuilder, CognitoSyncAsyncClientBuilder, ComprehendAsyncClientBuilder, ConfigAsyncClientBuilder, CostandUsageReportAsyncClientBuilder, CostExplorerAsyncClientBuilder, DatabaseMigrationAsyncClientBuilder, DataPipelineAsyncClientBuilder, DAXAsyncClientBuilder, DeviceFarmAsyncClientBuilder, DirectConnectAsyncClientBuilder, DirectoryAsyncClientBuilder, DynamoDBAsyncClientBuilder, DynamoDBStreamsAsyncClientBuilder, EC2AsyncClientBuilder, ECRAsyncClientBuilder, ECSAsyncClientBuilder, EFSAsyncClientBuilder, ElastiCacheAsyncClientBuilder, ElasticBeanstalkAsyncClientBuilder, ElasticLoadBalancingAsyncClientBuilder, ElasticLoadBalancingv2AsyncClientBuilder, ElasticsearchAsyncClientBuilder, ElasticTranscoderAsyncClientBuilder, EMRAsyncClientBuilder, FirehoseAsyncClientBuilder, GameLiftAsyncClientBuilder, GlacierAsyncClientBuilder, GlueAsyncClientBuilder, GreengrassAsyncClientBuilder, GuardDutyAsyncClientBuilder, HealthAsyncClientBuilder, IAMAsyncClientBuilder, ImportExportAsyncClientBuilder, InspectorAsyncClientBuilder, IoTAsyncClientBuilder, IoTDataPlaneAsyncClientBuilder, KinesisAnalyticsAsyncClientBuilder, KinesisAsyncClientBuilder, KinesisVideoAsyncClientBuilder, KMSAsyncClientBuilder, LambdaAsyncClientBuilder, LexModelBuildingAsyncClientBuilder, LightsailAsyncClientBuilder, MachineLearningAsyncClientBuilder, MarketplaceCommerceAnalyticsAsyncClientBuilder, MarketplaceEntitlementAsyncClientBuilder, MarketplaceMeteringAsyncClientBuilder, MediaConvertAsyncClientBuilder, MediaLiveAsyncClientBuilder, MediaPackageAsyncClientBuilder, MediaStoreAsyncClientBuilder, MigrationHubAsyncClientBuilder, MobileAsyncClientBuilder, MQAsyncClientBuilder, MTurkAsyncClientBuilder, OpsWorksAsyncClientBuilder, OpsWorksCMAsyncClientBuilder, OrganizationsAsyncClientBuilder, PinpointAsyncClientBuilder, PollyAsyncClientBuilder, PricingAsyncClientBuilder, RDSAsyncClientBuilder, RedshiftAsyncClientBuilder, RekognitionAsyncClientBuilder, ResourceGroupsAsyncClientBuilder, ResourceGroupsTaggingAPIAsyncClientBuilder, Route53AsyncClientBuilder, Route53DomainsAsyncClientBuilder, S3AsyncClientBuilder, SageMakerAsyncClientBuilder, ServerlessApplicationRepositoryAsyncClientBuilder, ServiceCatalogAsyncClientBuilder, ServiceDiscoveryAsyncClientBuilder, SESAsyncClientBuilder, SFNAsyncClientBuilder, ShieldAsyncClientBuilder, SimpleDBAsyncClientBuilder, SMSAsyncClientBuilder, SnowballAsyncClientBuilder, SNSAsyncClientBuilder, SQSAsyncClientBuilder, SSMAsyncClientBuilder, StorageGatewayAsyncClientBuilder, STSAsyncClientBuilder, SupportAsyncClientBuilder, SWFAsyncClientBuilder, TranslateAsyncClientBuilder, WAFAsyncClientBuilder, WAFRegionalAsyncClientBuilder, WorkDocsAsyncClientBuilder, WorkMailAsyncClientBuilder, WorkSpacesAsyncClientBuilder, XRayAsyncClientBuilder

public interface AsyncClientBuilder<B extends AsyncClientBuilder<B,C>,C>
extends ClientBuilder<B,C>

This includes required and optional override configuration required by every async client builder. An instance can be acquired by calling the static "builder" method on the type of async client you wish to create.

Implementations of this interface are mutable and not thread-safe.

Method Summary

Modifier and Type	Method and Description
B	asyncExecutorProvider(ExecutorProvider asyncExecutorProvider) Configure the executor service provider that generates ScheduledExecutorService instances to queue up async tasks in the client.
B	asyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration) Configures the HTTP client used by the service client.
default B	asyncHttpConfiguration(Consumer<ClientAsyncHttpConfiguration.Builder> asyncHttpConfiguration) Configures the HTTP client used by the service client.

Methods inherited from interface software.amazon.awssdk.core.client.builder.ClientBuilder

credentialsProvider, endpointOverride, overrideConfiguration, overrideConfiguration, region

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

asyncExecutorProvider

B asyncExecutorProvider(ExecutorProvider asyncExecutorProvider)

Configure the executor service provider that generates ScheduledExecutorService instances to queue up async tasks in the client. This executor is used for various processes within the async client like queueing up retries, it is not used to make or process the actual HTTP request (that's handled by the Async HTTP implementation and can be configured via asyncHttpConfiguration(ClientAsyncHttpConfiguration) as the implementation allows).

A new ExecutorService will be created from this provider each time SdkBuilder.build() is invoked.

asyncHttpConfiguration

B asyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration)

Configures the HTTP client used by the service client. Either a client factory may be provided (in which case the SDK will merge any service specific configuration on top of customer supplied configuration) or provide an already constructed instance of SdkAsyncHttpClient. Note that if an SdkAsyncHttpClient is provided then it is up to the caller to close it when they are finished with it, the SDK will only close HTTP clients that it creates.

asyncHttpConfiguration

default B asyncHttpConfiguration(Consumer<ClientAsyncHttpConfiguration.Builder> asyncHttpConfiguration)

Configures the HTTP client used by the service client. Allows just specifying the builder parameters without having to instantiate a builder and call build on it. For example

     builder().asyncHttpConfiguration(b -> b.httpClient(client));
 

See Also:

asyncHttpConfiguration(ClientAsyncHttpConfiguration)