Package com.azure.resourcemanager.resources.fluentcore.policy

Class ReturnRequestIdHeaderPolicy

java.lang.Object
com.azure.resourcemanager.resources.fluentcore.policy.ReturnRequestIdHeaderPolicy
All Implemented Interfaces:
com.azure.core.http.policy.HttpPipelinePolicy
public class ReturnRequestIdHeaderPolicy extends Object implements com.azure.core.http.policy.HttpPipelinePolicy
An interceptor for requesting server return client-request-id in response headers. Optionally, fill-in the client-request-id, if server does not return it in response headers.

ReturnRequestIdHeaderInterceptor should be added after RequestIdPolicy.

See Also:
  • RequestIdPolicy

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ReturnRequestIdHeaderPolicy.Option
    Additional client handling, if server does not return client-request-id in response headers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ReturnRequestIdHeaderPolicy()
    Creates a new instance of ReturnRequestIdHeaderPolicy.
    ReturnRequestIdHeaderPolicy(ReturnRequestIdHeaderPolicy.Option option)
    Creates a new instance of ReturnRequestIdHeaderPolicy.

  • Method Summary

    Modifier and Type
    Method
    Description
    Mono<com.azure.core.http.HttpResponse>
    process(com.azure.core.http.HttpPipelineCallContext context, com.azure.core.http.HttpPipelineNextPolicy next)
    Processes provided request context and invokes the next policy.

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

  • Constructor Details

    • ReturnRequestIdHeaderPolicy

      public ReturnRequestIdHeaderPolicy()
      Creates a new instance of ReturnRequestIdHeaderPolicy. Sets "x-ms-return-client-request-id: true" in requests headers.

    • ReturnRequestIdHeaderPolicy

      public ReturnRequestIdHeaderPolicy(ReturnRequestIdHeaderPolicy.Option option)
      Creates a new instance of ReturnRequestIdHeaderPolicy. Sets "x-ms-return-client-request-id: true" in requests headers.

      Optionally fill-in the client-request-id if server does not return it in response headers.

      Parameters:
      option - the option of additional client handling, if server does not return client-request-id in response headers.

  • Method Details

    • process

      public Mono<com.azure.core.http.HttpResponse> process(com.azure.core.http.HttpPipelineCallContext context, com.azure.core.http.HttpPipelineNextPolicy next)
      Description copied from interface: com.azure.core.http.policy.HttpPipelinePolicy
      Processes provided request context and invokes the next policy.
      Specified by:
      process in interface com.azure.core.http.policy.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.