Package software.amazon.awssdk.http.pipeline

Class RequestPipelineBuilder<InputT,OutputT>

java.lang.Object

software.amazon.awssdk.http.pipeline.RequestPipelineBuilder<InputT,OutputT>

Type Parameters:

InputT - Currently configured input type to the RequestPipeline.

OutputT - Currently configured output type to the RequestPipeline.

@Immutable
public class RequestPipelineBuilder<InputT,OutputT>
extends Object

Builder for a RequestPipeline.

Method Summary

Modifier and Type	Method	Description
static <InputT,OutputT> Function<HttpClientDependencies,RequestPipeline<CompletableFuture<InputT>,CompletableFuture<OutputT>>>	async(Function<HttpClientDependencies,RequestPipeline<InputT,OutputT>> pipelineFactory)	Convert a synchronous RequestPipeline factory into a factory that produces a version of the RequestPipeline that accepts a CompletableFuture and returns a CompletableFuture.
static <InputT,OutputT> Function<HttpClientDependencies,RequestPipeline<CompletableFuture<InputT>,CompletableFuture<OutputT>>>	async(Supplier<RequestPipeline<InputT,OutputT>> pipelineFactory)	A version of async(Function) that takes a Supplier
RequestPipeline<InputT,OutputT>	build(HttpClientDependencies dependencies)	Construct the RequestPipeline with the currently configured stages.
static <InputT,OutputT> RequestPipelineBuilder<InputT,OutputT>	first(Function<HttpClientDependencies,RequestPipeline<InputT,OutputT>> pipelineFactory)	Factory method to create a RequestPipelineBuilder with an initial pipeline stage.
static <InputT,OutputT> RequestPipelineBuilder<InputT,OutputT>	first(Supplier<RequestPipeline<InputT,OutputT>> pipelineFactory)	Factory method to create a RequestPipelineBuilder with an initial pipeline stage.
<NewOutputT> RequestPipelineBuilder<InputT,NewOutputT>	then(Function<HttpClientDependencies,RequestPipeline<OutputT,NewOutputT>> pipelineFactory)	Factory method to chain the current RequestPipelineBuilder with another pipeline stage.
<NewOutputT> RequestPipelineBuilder<InputT,NewOutputT>	then(Supplier<RequestPipeline<OutputT,NewOutputT>> pipelineFactory)	Factory method to chain the current RequestPipelineBuilder with another pipeline stage.
<NewInputT,NewOutputT> RequestPipelineBuilder<NewInputT,NewOutputT>	wrap(BiFunction<HttpClientDependencies,RequestPipeline<InputT,OutputT>,RequestPipeline<NewInputT,NewOutputT>> wrappedFactory)	Factory method to wrap the current RequestPipelineBuilder with another pipeline stage.
<NewInputT,NewOutputT> RequestPipelineBuilder<NewInputT,NewOutputT>	wrap(Function<RequestPipeline<InputT,OutputT>,RequestPipeline<NewInputT,NewOutputT>> wrappedFactory)	Factory method to wrap the current RequestPipelineBuilder with another pipeline stage.

Methods inherited from class java.lang.Object

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

Method Detail

first

public static <InputT,OutputT> RequestPipelineBuilder<InputT,OutputT> first(Function<HttpClientDependencies,RequestPipeline<InputT,OutputT>> pipelineFactory)

Factory method to create a RequestPipelineBuilder with an initial pipeline stage.

Type Parameters:

InputT - Input type of pipeline

OutputT - Output type of pipeline.

Parameters:

pipelineFactory - Factory that can produce a RequestPipeline. Should take an HttpClientDependencies object as the first parameter to the factory method.

Returns:

RequestPipelineBuilder composed of that initial stage.

See Also:

build(HttpClientDependencies)

first

public static <InputT,OutputT> RequestPipelineBuilder<InputT,OutputT> first(Supplier<RequestPipeline<InputT,OutputT>> pipelineFactory)

Factory method to create a RequestPipelineBuilder with an initial pipeline stage.

Type Parameters:

InputT - Input type of pipeline

OutputT - Output type of pipeline.

Parameters:

pipelineFactory - Factory that can produce a RequestPipeline. Use this overload when the factory does not need HttpClientDependencies and should instead take no arguments.

Returns:

RequestPipelineBuilder composed of that initial stage.

See Also:

build(HttpClientDependencies)

then

public <NewOutputT> RequestPipelineBuilder<InputT,NewOutputT> then(Function<HttpClientDependencies,RequestPipeline<OutputT,NewOutputT>> pipelineFactory)

Factory method to chain the current RequestPipelineBuilder with another pipeline stage. The new stage's input type must match the current stage's output type. The new stage may define a new output type (if it's transforming the type) or may define the same output type as the current stage.

Type Parameters:

NewOutputT - New output type of pipeline

Parameters:

pipelineFactory - Factory that can produce a RequestPipeline. Should take an HttpClientDependencies object as the first parameter to the factory method.

Returns:

A new RequestPipelineBuilder composed of the previous stages and the new stage.

See Also:

build(HttpClientDependencies)

async

public static <InputT,OutputT> Function<HttpClientDependencies,RequestPipeline<CompletableFuture<InputT>,CompletableFuture<OutputT>>> async(Function<HttpClientDependencies,RequestPipeline<InputT,OutputT>> pipelineFactory)

Convert a synchronous RequestPipeline factory into a factory that produces a version of the RequestPipeline that accepts a CompletableFuture and returns a CompletableFuture.

Type Parameters:

InputT - the input type of the original RequestPipeline

OutputT - the return type of the original RequestPipeline

Parameters:

pipelineFactory - the delegate pipeline factory to wrap

Returns:

the wrapped RequestPipeline factory

async

public static <InputT,OutputT> Function<HttpClientDependencies,RequestPipeline<CompletableFuture<InputT>,CompletableFuture<OutputT>>> async(Supplier<RequestPipeline<InputT,OutputT>> pipelineFactory)

A version of async(Function) that takes a Supplier

See Also:

async(Supplier)

then

public <NewOutputT> RequestPipelineBuilder<InputT,NewOutputT> then(Supplier<RequestPipeline<OutputT,NewOutputT>> pipelineFactory)

Factory method to chain the current RequestPipelineBuilder with another pipeline stage. The new stage's input type must match the current stage's output type. The new stage may define a new output type (if it's transforming the type) or may define the same output type as the current stage.

Type Parameters:

NewOutputT - New output type of pipeline

Parameters:

pipelineFactory - Factory that can produce a RequestPipeline. Use this overload when the factory does not need HttpClientDependencies and should instead take no arguments.

Returns:

A new RequestPipelineBuilder composed of the previous stages and the new stage.

See Also:

build(HttpClientDependencies)

wrap

public <NewInputT,NewOutputT> RequestPipelineBuilder<NewInputT,NewOutputT> wrap(BiFunction<HttpClientDependencies,RequestPipeline<InputT,OutputT>,RequestPipeline<NewInputT,NewOutputT>> wrappedFactory)

Factory method to wrap the current RequestPipelineBuilder with another pipeline stage. The argument to wrap is a factory that takes an HttpClientDependencies object and a inner RequestPipeline (the current one being built) as arguments and produces a new RequestPipeline for the wrapper. The wrapper may have entirely different input and output types, typically it will have the same however.

Type Parameters:

NewOutputT - New output type of pipeline

Parameters:

wrappedFactory - BiFunction factory that can produce a RequestPipeline. The arguments to the factory will be HttpClientDependencies and an inner RequestPipeline.

Returns:

A new RequestPipelineBuilder that wraps around the pipeline currently being constructed.

See Also:

build(HttpClientDependencies)

wrap

public <NewInputT,NewOutputT> RequestPipelineBuilder<NewInputT,NewOutputT> wrap(Function<RequestPipeline<InputT,OutputT>,RequestPipeline<NewInputT,NewOutputT>> wrappedFactory)

Factory method to wrap the current RequestPipelineBuilder with another pipeline stage. The argument to wrap is a factory that takes an inner RequestPipeline (the current one being built) as an argument and produces a new RequestPipeline for the wrapper. The wrapper may have entirely different input and output types, typically it will have the same however.

Type Parameters:

NewOutputT - New output type of pipeline

Parameters:

wrappedFactory - Function factory that can produce a RequestPipeline. The argument to the factory will be an inner RequestPipeline.

Returns:

A new RequestPipelineBuilder that wraps around the pipeline currently being constructed.

See Also:

build(HttpClientDependencies)

build

public RequestPipeline<InputT,OutputT> build(HttpClientDependencies dependencies)

Construct the RequestPipeline with the currently configured stages.

Parameters:

dependencies - HttpClientDependencies to supply to factory methods that are interested in it.

Returns:

Constructed RequestPipeline.

See Also:

RequestPipeline.execute(Object, RequestExecutionContext)