104 строки
9.2 KiB
YAML
104 строки
9.2 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.http.HttpPipelineBuilder"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder"
|
|
name: "HttpPipelineBuilder"
|
|
nameWithType: "HttpPipelineBuilder"
|
|
summary: "This class provides a fluent builder API to help aid the configuration and instantiation of the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>, calling <xref uid=\"com.azure.core.http.HttpPipelineBuilder.build()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"build\"></xref> constructs an instance of the pipeline."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **HttpPipelineBuilder**"
|
|
constructors:
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.HttpPipelineBuilder()"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.HttpPipelineBuilder()"
|
|
name: "HttpPipelineBuilder()"
|
|
nameWithType: "HttpPipelineBuilder.HttpPipelineBuilder()"
|
|
summary: "Creates a new instance of Http<wbr>Pipeline<wbr>Builder that can configure options for the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> before creating an instance of it."
|
|
syntax: "public HttpPipelineBuilder()"
|
|
desc: "Creates a new instance of HttpPipelineBuilder that can configure options for the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> before creating an instance of it."
|
|
methods:
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.build()"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.build()"
|
|
name: "build()"
|
|
nameWithType: "HttpPipelineBuilder.build()"
|
|
summary: "Creates an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> based on options set in the builder."
|
|
syntax: "public HttpPipeline build()"
|
|
desc: "Creates an <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> based on options set in the builder. Every time `build()` is called, a new instance of <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is created.\n\nIf HttpClient is not set then a default HttpClient is used."
|
|
returns:
|
|
description: "A HttpPipeline with the options set from the builder."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.clientOptions(ClientOptions clientOptions)"
|
|
name: "clientOptions(ClientOptions clientOptions)"
|
|
nameWithType: "HttpPipelineBuilder.clientOptions(ClientOptions clientOptions)"
|
|
summary: "Sets the Client<wbr>Options that will configure the pipeline."
|
|
parameters:
|
|
- description: "The ClientOptions that will configure the pipeline."
|
|
name: "clientOptions"
|
|
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpPipelineBuilder clientOptions(ClientOptions clientOptions)"
|
|
desc: "Sets the ClientOptions that will configure the pipeline."
|
|
returns:
|
|
description: "The updated HttpPipelineBuilder object."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineBuilder?alt=com.azure.core.http.HttpPipelineBuilder&text=HttpPipelineBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.httpClient(com.azure.core.http.HttpClient)"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.httpClient(HttpClient httpClient)"
|
|
name: "httpClient(HttpClient httpClient)"
|
|
nameWithType: "HttpPipelineBuilder.httpClient(HttpClient httpClient)"
|
|
summary: "Sets the Http<wbr>Client that the pipeline will use to send requests."
|
|
parameters:
|
|
- description: "The HttpClient the pipeline will use when sending requests."
|
|
name: "httpClient"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpPipelineBuilder httpClient(HttpClient httpClient)"
|
|
desc: "Sets the HttpClient that the pipeline will use to send requests."
|
|
returns:
|
|
description: "The updated HttpPipelineBuilder object."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineBuilder?alt=com.azure.core.http.HttpPipelineBuilder&text=HttpPipelineBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.policies(com.azure.core.http.policy.HttpPipelinePolicy...)"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.policies(HttpPipelinePolicy[] policies)"
|
|
name: "policies(HttpPipelinePolicy[] policies)"
|
|
nameWithType: "HttpPipelineBuilder.policies(HttpPipelinePolicy[] policies)"
|
|
summary: "Adds <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"policies\"></xref> to the set of policies that the pipeline will use when sending requests."
|
|
parameters:
|
|
- description: "Policies to add to the policy set."
|
|
name: "policies"
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />[]"
|
|
syntax: "public HttpPipelineBuilder policies(HttpPipelinePolicy[] policies)"
|
|
desc: "Adds <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"policies\"></xref> to the set of policies that the pipeline will use when sending requests."
|
|
returns:
|
|
description: "The updated HttpPipelineBuilder object."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineBuilder?alt=com.azure.core.http.HttpPipelineBuilder&text=HttpPipelineBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipelineBuilder.tracer(com.azure.core.util.tracing.Tracer)"
|
|
fullName: "com.azure.core.http.HttpPipelineBuilder.tracer(Tracer tracer)"
|
|
name: "tracer(Tracer tracer)"
|
|
nameWithType: "HttpPipelineBuilder.tracer(Tracer tracer)"
|
|
summary: "Sets the Tracer to trace logical and HTTP calls."
|
|
parameters:
|
|
- description: "The Tracer instance."
|
|
name: "tracer"
|
|
type: "<xref href=\"com.azure.core.util.tracing.Tracer?alt=com.azure.core.util.tracing.Tracer&text=Tracer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpPipelineBuilder tracer(Tracer tracer)"
|
|
desc: "Sets the Tracer to trace logical and HTTP calls."
|
|
returns:
|
|
description: "The updated HttpPipelineBuilder object."
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineBuilder?alt=com.azure.core.http.HttpPipelineBuilder&text=HttpPipelineBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "This class provides a fluent builder API to help aid the configuration and instantiation of the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>, calling <xref uid=\"com.azure.core.http.HttpPipelineBuilder.build()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"build\"></xref> constructs an instance of the pipeline.\n\nA 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.\n\n**Code Samples**\n\nCreate a pipeline without configuration\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder().build();\n```\n\nCreate a pipeline using the default HTTP client and a retry policy\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n .httpClient(HttpClient.createDefault())\n .policies(new RetryPolicy())\n .build();\n```"
|
|
metadata: {}
|
|
package: "com.azure.core.http"
|
|
artifact: com.azure:azure-core:1.54.0
|