RequestIdPolicy Class

Package:: com.azure.core.http.policy

Maven Artifact:: com.azure:azure-core:1.57.1

java.lang.Object
- com.azure.core.http.policy.RequestIdPolicy

Implements

public class RequestIdPolicy
implements HttpPipelinePolicy

The RequestIdPolicy class is an implementation of the HttpPipelinePolicy interface. This policy is used to add a unique identifier to each HttpRequest in the form of a UUID in the request header. Azure uses the request id as the unique identifier for the request.

This class is useful when you need to track HTTP requests for debugging or auditing purposes. It allows you to specify a custom header name for the request id, or use the default header name 'x-ms-client-request-id'.

Code sample:

In this example, a RequestIdPolicy is created with a custom header name. Once added to the pipeline requests will have their request id set in the 'x-ms-my-custom-request-id' header by the RequestIdPolicy.

// Using the default header name
 RequestIdPolicy defaultPolicy = new RequestIdPolicy();
 // Using a custom header name
 RequestIdPolicy customRequestIdPolicy = new RequestIdPolicy("x-ms-my-custom-request-id");

Constructor Summary

Constructor	Description
RequestIdPolicy()	Creates default RequestIdPolicy with default header name 'x-ms-client-request-id'.
RequestIdPolicy(String requestIdHeaderName)	Creates RequestIdPolicy with provided `requestIdHeaderName`.

Method Summary

Modifier and Type	Method and Description
Mono<HttpResponse>	process(HttpPipelineCallContext context, HttpPipelineNextPolicy next) Processes provided request context and invokes the next policy.
HttpResponse	processSync(HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) Processes provided request context and invokes the next policy synchronously.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details