Package com.azure.core.http.policy

Class RequestIdPolicy

java.lang.Object
com.azure.core.http.policy.RequestIdPolicy
All Implemented Interfaces:
HttpPipelinePolicy
public class RequestIdPolicy extends Object 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");
See Also:

  • Constructor Details

    • RequestIdPolicy

      public RequestIdPolicy(String requestIdHeaderName)
      Creates RequestIdPolicy with provided requestIdHeaderName.
      Parameters:
      requestIdHeaderName - to be used to set in HttpRequest.

    • RequestIdPolicy

      public RequestIdPolicy()
      Creates default RequestIdPolicy with default header name 'x-ms-client-request-id'.

  • Method Details