Package com.azure.core.http.policy
Class RequestIdPolicy
java.lang.Object
com.azure.core.http.policy.RequestIdPolicy
- All Implemented Interfaces:
HttpPipelinePolicy
The pipeline policy that puts a UUID in the request header. Azure uses the request id as
the unique identifier for the request.
The default HttpHeader
name can be overwritten as shown below
Code sample
new RequestIdPolicy("x-ms-my-custom-request-id");
-
Constructor Summary
ConstructorDescriptionCreates defaultRequestIdPolicy
with default header name 'x-ms-client-request-id'.RequestIdPolicy
(String requestIdHeaderName) CreatesRequestIdPolicy
with providedrequestIdHeaderName
. -
Method Summary
Modifier and TypeMethodDescriptionprocess
(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.processSync
(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.azure.core.http.policy.HttpPipelinePolicy
getPipelinePosition
-
Constructor Details
-
RequestIdPolicy
CreatesRequestIdPolicy
with providedrequestIdHeaderName
.- Parameters:
requestIdHeaderName
- to be used to set inHttpRequest
.
-
RequestIdPolicy
public RequestIdPolicy()Creates defaultRequestIdPolicy
with default header name 'x-ms-client-request-id'.
-
-
Method Details
-
process
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy.- Specified by:
process
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-
processSync
Description copied from interface:HttpPipelinePolicy
Processes provided request context and invokes the next policy synchronously.- Specified by:
processSync
in interfaceHttpPipelinePolicy
- Parameters:
context
- The request context.next
- The next policy to invoke.- Returns:
- A publisher that initiates the request upon subscription and emits a response on completion.
-