Class AmqpClientOptions

java.lang.Object
com.azure.core.util.ClientOptions
com.azure.core.amqp.AmqpClientOptions

public final class AmqpClientOptions extends ClientOptions
General configuration options for AMQP clients.
  • Constructor Details

    • AmqpClientOptions

      public AmqpClientOptions()
  • Method Details

    • setApplicationId

      public AmqpClientOptions setApplicationId(String applicationId)
      Sets the application ID.

      The applicationId is used to configure UserAgentPolicy for telemetry/monitoring purposes.

      See Azure Core: Telemetry policy for additional information.

      Code Samples

      Create ClientOptions with application ID 'myApplicationId'

       ClientOptions clientOptions = new ClientOptions()
           .setApplicationId("myApplicationId");
       
      Overrides:
      setApplicationId in class ClientOptions
      Parameters:
      applicationId - The application ID.
      Returns:
      The updated ClientOptions object.
    • setHeaders

      public AmqpClientOptions setHeaders(Iterable<Header> headers)
      Sets the Headers.

      The passed headers are applied to each request sent with the client.

      This overwrites all previously set headers.

      Code Samples

      Create ClientOptions with Header 'myCustomHeader':'myStaticValue'

       ClientOptions clientOptions = new ClientOptions()
           .setHeaders(Collections.singletonList(new Header("myCustomHeader", "myStaticValue")));
       
      Overrides:
      setHeaders in class ClientOptions
      Parameters:
      headers - The headers.
      Returns:
      The updated ClientOptions object.
    • getIdentifier

      public String getIdentifier()
      Gets the identifier for the AMQP client.
      Returns:
      AMQP client identifier.
    • setIdentifier

      public AmqpClientOptions setIdentifier(String identifier)
      Sets the identifier for the AMQP client.
      Parameters:
      identifier - A specific string to identify AMQP client. If null or empty, a UUID will be used as the identifier.
      Returns:
      The updated AmqpClientOptions object.