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 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

Constructors

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	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 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

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

process

public Mono<HttpResponse> process(HttpPipelineCallContext context,
 HttpPipelineNextPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy.

Specified by:

process in interface HttpPipelinePolicy

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

public HttpResponse processSync(HttpPipelineCallContext context,
 HttpPipelineNextSyncPolicy next)

Description copied from interface: HttpPipelinePolicy

Processes provided request context and invokes the next policy synchronously.

Specified by:

processSync in interface HttpPipelinePolicy

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.