org.apache.beam.sdk.io.aws2.common

Interface ClientBuilderFactory

All Known Implementing Classes:

ClientBuilderFactory.DefaultClientBuilder

public interface ClientBuilderFactory

Factory to build and configure any AwsClientBuilder using a specific ClientConfiguration or the globally provided settings in AwsOptions as fallback.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientBuilderFactory.DefaultClientBuilder Default implementation of ClientBuilderFactory.

Method Summary

Modifier and Type	Method and Description
static <BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> ClientT	buildClient(AwsOptions options, BuilderT builder, ClientConfiguration config) Utility to directly build a client of type ClientT using builder of BuilderT.
void	checkConfiguration(ClientConfiguration config, AwsOptions defaults) Check if all necessary configuration is available to create clients.
default <BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> BuilderT	create(BuilderT builder, AwsOptions defaults) Configure a client builder BuilderT using the global defaults in AwsOptions.
<BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> BuilderT	create(BuilderT builder, ClientConfiguration config, AwsOptions defaults) Configure a client builder BuilderT using the provided ClientConfiguration and fall back to the global defaults in AwsOptions where necessary.
static ClientBuilderFactory	defaultFactory() The default ClientBuilderFactory instance.
static ClientBuilderFactory	getFactory(AwsOptions options) Get a ClientBuilderFactory instance according to AwsOptions.getClientBuilderFactory().
static void	validate(AwsOptions options, ClientConfiguration config) Utility to validate if all necessary configuration is available to create clients using the ClientBuilderFactory configured in AwsOptions.

Method Detail

create

default <BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> BuilderT create(BuilderT builder,
                                                                                      @Nullable
                                                                                      AwsOptions defaults)

Configure a client builder BuilderT using the global defaults in AwsOptions.

create

<BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> BuilderT create(BuilderT builder,
                                                                              ClientConfiguration config,
                                                                              @Nullable
                                                                              AwsOptions defaults)

Configure a client builder BuilderT using the provided ClientConfiguration and fall back to the global defaults in AwsOptions where necessary.

checkConfiguration

void checkConfiguration(ClientConfiguration config,
                        @Nullable
                        AwsOptions defaults)

Check if all necessary configuration is available to create clients.

Throws:

java.lang.RuntimeException - if configuration is incomplete.

defaultFactory

static ClientBuilderFactory defaultFactory()

The default ClientBuilderFactory instance.

getFactory

static ClientBuilderFactory getFactory(AwsOptions options)

Get a ClientBuilderFactory instance according to AwsOptions.getClientBuilderFactory().

validate

static void validate(AwsOptions options,
                     ClientConfiguration config)

Utility to validate if all necessary configuration is available to create clients using the ClientBuilderFactory configured in AwsOptions.

buildClient

static <BuilderT extends AwsClientBuilder<BuilderT,ClientT>,ClientT> ClientT buildClient(AwsOptions options,
                                                                                         BuilderT builder,
                                                                                         ClientConfiguration config)

Utility to directly build a client of type ClientT using builder of BuilderT.

The client is created using the ClientBuilderFactory configured in AwsOptions with the provided ClientConfiguration and global defaults from AwsOptions.