Package com.azure.android.core.http
Class HttpPipelineBuilder
- java.lang.Object
-
- com.azure.android.core.http.HttpPipelineBuilder
-
public class HttpPipelineBuilder extends java.lang.Object
This class provides a fluent builder API to help aid the configuration and instantiation of theHttpPipeline
, callingbuild
constructs an instance of the pipeline.A pipeline is configured with a HttpClient that sends the request, if no client is set a default is used. A pipeline may be configured with a list of policies that are applied to each request.
Create a pipeline without configuration
new HttpPipelineBuilder() .build();
Create a pipeline using the default HTTP client and a retry policy
new HttpPipelineBuilder() .httpClient(HttpClient.createDefault()) .policies(new RetryPolicy()) .build();
- See Also:
HttpPipeline
-
-
Constructor Summary
Constructors Constructor Description HttpPipelineBuilder()
Creates a new instance of HttpPipelineBuilder that can configure options for theHttpPipeline
before creating an instance of it.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpPipeline
build()
Creates aHttpPipeline
based on options set in the Builder.HttpPipelineBuilder
httpClient(HttpClient httpClient)
Sets the HttpClient that the pipeline will use to send requests.HttpPipelineBuilder
policies(HttpPipelinePolicy... policies)
Addspolicies
to the set of policies that the pipeline will use when sending requests.
-
-
-
Constructor Detail
-
HttpPipelineBuilder
public HttpPipelineBuilder()
Creates a new instance of HttpPipelineBuilder that can configure options for theHttpPipeline
before creating an instance of it.
-
-
Method Detail
-
build
public HttpPipeline build()
Creates aHttpPipeline
based on options set in the Builder. Every timebuild()
is called, a new instance ofHttpPipeline
is created. If HttpClient is not set then thedefault HttpClient
is used.- Returns:
- A HttpPipeline with the options set from the builder.
-
httpClient
public HttpPipelineBuilder httpClient(HttpClient httpClient)
Sets the HttpClient that the pipeline will use to send requests.- Parameters:
httpClient
- The HttpClient the pipeline will use when sending requests.- Returns:
- The updated HttpPipelineBuilder object.
-
policies
public HttpPipelineBuilder policies(HttpPipelinePolicy... policies)
Addspolicies
to the set of policies that the pipeline will use when sending requests.- Parameters:
policies
- Policies to add to the policy set.- Returns:
- The updated HttpPipelineBuilder object.
-
-