com.ibm.cos.v2.core.client.builder

Interface SdkClientBuilder<B extends SdkClientBuilder<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:

Buildable, SdkBuilder<B,C>

All Known Subinterfaces:

AwsClientBuilder<BuilderT,ClientT>, S3AsyncClientBuilder, S3BaseClientBuilder<B,C>, S3ClientBuilder

All Known Implementing Classes:

AwsDefaultClientBuilder, SdkDefaultClientBuilder

public interface SdkClientBuilder<B extends SdkClientBuilder<B,C>,C>
extends SdkBuilder<B,C>

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

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

Method Summary

Modifier and Type	Method and Description
default B	addPlugin(SdkPlugin plugin) Adds a plugin to the client builder.
B	endpointOverride(URI endpointOverride) Configure the endpoint with which the SDK should communicate.
default B	iamEndpoint(String iamEndpoint) Sets the IAM endpoint to use for token retrieval by the DefaultTokenManager and the DefaultTokenProvider.
ClientOverrideConfiguration	overrideConfiguration() Retrieve the current override configuration.
B	overrideConfiguration(ClientOverrideConfiguration overrideConfiguration) Specify overrides to the default SDK configuration that should be used for clients created by this builder.
default B	overrideConfiguration(Consumer<ClientOverrideConfiguration.Builder> overrideConfiguration) Similar to overrideConfiguration(ClientOverrideConfiguration), but takes a lambda to configure a new ClientOverrideConfiguration.Builder.
default List<SdkPlugin>	plugins() Returns the list of plugins configured on the client builder.
default B	putAuthScheme(AuthScheme<?> authScheme) Configure this client with an additional auth scheme, or replace one already on the client.

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

Method Detail

overrideConfiguration

B overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

Specify overrides to the default SDK configuration that should be used for clients created by this builder.

overrideConfiguration

default B overrideConfiguration(Consumer<ClientOverrideConfiguration.Builder> overrideConfiguration)

Similar to overrideConfiguration(ClientOverrideConfiguration), but takes a lambda to configure a new ClientOverrideConfiguration.Builder. This removes the need to called ClientOverrideConfiguration.builder() and ClientOverrideConfiguration.Builder#build().

overrideConfiguration

ClientOverrideConfiguration overrideConfiguration()

Retrieve the current override configuration. This allows further overrides across calls. Can be modified by first converting to a builder with ClientOverrideConfiguration.toBuilder().

Returns:

The existing override configuration for the builder.

endpointOverride

B endpointOverride(URI endpointOverride)

Configure the endpoint with which the SDK should communicate.

It is important to know that EndpointProviders and the endpoint override on the client are not mutually exclusive. In all existing cases, the endpoint override is passed as a parameter to the provider and the provider *may* modify it. For example, the S3 provider may add the bucket name as a prefix to the endpoint override for virtual bucket addressing.

putAuthScheme

default B putAuthScheme(AuthScheme<?> authScheme)

Configure this client with an additional auth scheme, or replace one already on the client.

By default, the SDK will only know about default auth schemes that ship with the service. If you want to modify those existing auth schemes or add a custom one (you select with a custom auth scheme resolver), you can add that new auth scheme with this method.

addPlugin

default B addPlugin(SdkPlugin plugin)

Adds a plugin to the client builder. The plugins will be invoked when building the client to allow them to change the configuration of the built client.

plugins

default List<SdkPlugin> plugins()

Returns the list of plugins configured on the client builder.

iamEndpoint

default B iamEndpoint(String iamEndpoint)

Sets the IAM endpoint to use for token retrieval by the DefaultTokenManager and the DefaultTokenProvider. This should only be over written for a dev or staging environment

Parameters:

iamEndpoint, - http endpoint for token retrieval

Returns:

This object for method chaining.