136 строки
11 KiB
YAML
136 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.core.http.HttpPipeline"
|
|
fullName: "com.azure.core.http.HttpPipeline"
|
|
name: "HttpPipeline"
|
|
nameWithType: "HttpPipeline"
|
|
summary: "The HTTP pipeline through which HTTP requests and responses flow."
|
|
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 final class **HttpPipeline**"
|
|
methods:
|
|
- uid: "com.azure.core.http.HttpPipeline.getHttpClient()"
|
|
fullName: "com.azure.core.http.HttpPipeline.getHttpClient()"
|
|
name: "getHttpClient()"
|
|
nameWithType: "HttpPipeline.getHttpClient()"
|
|
summary: "Get the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> associated with the pipeline."
|
|
syntax: "public HttpClient getHttpClient()"
|
|
desc: "Get the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> associated with the pipeline."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> associated with the pipeline"
|
|
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipeline.getPolicy(int)"
|
|
fullName: "com.azure.core.http.HttpPipeline.getPolicy(int index)"
|
|
name: "getPolicy(int index)"
|
|
nameWithType: "HttpPipeline.getPolicy(int index)"
|
|
summary: "Get the policy at the passed index in the pipeline."
|
|
parameters:
|
|
- description: "index of the policy to retrieve."
|
|
name: "index"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpPipelinePolicy getPolicy(int index)"
|
|
desc: "Get the policy at the passed index in the pipeline."
|
|
returns:
|
|
description: "the policy stored at that index."
|
|
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipeline.getPolicyCount()"
|
|
fullName: "com.azure.core.http.HttpPipeline.getPolicyCount()"
|
|
name: "getPolicyCount()"
|
|
nameWithType: "HttpPipeline.getPolicyCount()"
|
|
summary: "Get the count of policies in the pipeline."
|
|
syntax: "public int getPolicyCount()"
|
|
desc: "Get the count of policies in the pipeline."
|
|
returns:
|
|
description: "count of policies."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipeline.getTracer()"
|
|
fullName: "com.azure.core.http.HttpPipeline.getTracer()"
|
|
name: "getTracer()"
|
|
nameWithType: "HttpPipeline.getTracer()"
|
|
summary: "Get the <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref> associated with the pipeline."
|
|
syntax: "public Tracer getTracer()"
|
|
desc: "Get the <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref> associated with the pipeline."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Tracer\"></xref> associated with the pipeline"
|
|
type: "<xref href=\"com.azure.core.util.tracing.Tracer?alt=com.azure.core.util.tracing.Tracer&text=Tracer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.core.http.HttpPipeline.send(com.azure.core.http.HttpPipelineCallContext)"
|
|
fullName: "com.azure.core.http.HttpPipeline.send(HttpPipelineCallContext context)"
|
|
name: "send(HttpPipelineCallContext context)"
|
|
nameWithType: "HttpPipeline.send(HttpPipelineCallContext context)"
|
|
summary: "Sends the context (containing an HTTP request) through pipeline."
|
|
parameters:
|
|
- description: "The request context."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<HttpResponse> send(HttpPipelineCallContext context)"
|
|
desc: "Sends the context (containing an HTTP request) through pipeline."
|
|
returns:
|
|
description: "A publisher upon subscription flows the context through policies, sends the request and emits response\n upon completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.http.HttpPipeline.send(com.azure.core.http.HttpRequest)"
|
|
fullName: "com.azure.core.http.HttpPipeline.send(HttpRequest request)"
|
|
name: "send(HttpRequest request)"
|
|
nameWithType: "HttpPipeline.send(HttpRequest request)"
|
|
summary: "Wraps the `request` in a context and sends it through pipeline."
|
|
parameters:
|
|
- description: "The HTTP request to send."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<HttpResponse> send(HttpRequest request)"
|
|
desc: "Wraps the `request` in a context and sends it through pipeline."
|
|
returns:
|
|
description: "A publisher upon subscription flows the context through policies, sends the request, and emits response\n upon completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.http.HttpPipeline.send(com.azure.core.http.HttpRequest,com.azure.core.util.Context)"
|
|
fullName: "com.azure.core.http.HttpPipeline.send(HttpRequest request, Context data)"
|
|
name: "send(HttpRequest request, Context data)"
|
|
nameWithType: "HttpPipeline.send(HttpRequest request, Context data)"
|
|
summary: "Wraps the request in a context with additional metadata and sends it through the pipeline."
|
|
parameters:
|
|
- description: "THe HTTP request to send."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Additional metadata to pass along with the request."
|
|
name: "data"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<HttpResponse> send(HttpRequest request, Context data)"
|
|
desc: "Wraps the request in a context with additional metadata and sends it through the pipeline."
|
|
returns:
|
|
description: "A publisher upon subscription flows the context through policies, sends the request, and emits response\n upon completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.core.http.HttpPipeline.sendSync(com.azure.core.http.HttpRequest,com.azure.core.util.Context)"
|
|
fullName: "com.azure.core.http.HttpPipeline.sendSync(HttpRequest request, Context data)"
|
|
name: "sendSync(HttpRequest request, Context data)"
|
|
nameWithType: "HttpPipeline.sendSync(HttpRequest request, Context data)"
|
|
summary: "Wraps the request in a context with additional metadata and sends it through the pipeline."
|
|
parameters:
|
|
- description: "THe HTTP request to send."
|
|
name: "request"
|
|
type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Additional metadata to pass along with the request."
|
|
name: "data"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public HttpResponse sendSync(HttpRequest request, Context data)"
|
|
desc: "Wraps the request in a context with additional metadata and sends it through the pipeline."
|
|
returns:
|
|
description: "A publisher upon subscription flows the context through policies, sends the request, and emits response\n upon completion."
|
|
type: "<xref href=\"com.azure.core.http.HttpResponse?alt=com.azure.core.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The HTTP pipeline through which HTTP requests and responses flow.\n\nThis class encapsulates the HTTP pipeline that applies a set of <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipelinePolicies\"></xref> to the request before it is sent and on the response as it is being returned.\n\nIt provides methods to get the policy at a specific index in the pipeline, get the count of policies in the pipeline, get the associated <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref>, and send the HTTP request through the pipeline.\n\nThis class is useful when you want to send an HTTP request and apply a set of policies to the request and response."
|
|
metadata: {}
|
|
package: "com.azure.core.http"
|
|
artifact: com.azure:azure-core:1.54.0
|