Package com.azure.spring.cloud.core.properties.client

Class HttpLoggingProperties

java.lang.Object

com.azure.spring.cloud.core.properties.client.HttpLoggingProperties

All Implemented Interfaces:

HttpLoggingOptionsProvider.HttpLoggingOptions

public final class HttpLoggingProperties
extends Object
implements HttpLoggingOptionsProvider.HttpLoggingOptions

Options related to http logging. For example, if you want to log the http request or response, you could set the level to HttpLogDetailLevel.BASIC or some other levels.

Constructor Summary

Constructors

Constructor	Description
HttpLoggingProperties()	Creates an instance of HttpLoggingProperties.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllowedHeaderNames()	Gets the allowlist headers that should be logged.
Set<String>	getAllowedQueryParamNames()	Gets the allowlist query parameters.
com.azure.core.http.policy.HttpLogDetailLevel	getLevel()	Gets the level of detail to log on HTTP messages.
Boolean	getPrettyPrintBody()	Gets flag to allow pretty printing of message bodies.
void	setLevel(com.azure.core.http.policy.HttpLogDetailLevel level)	Set the logging detail level.
void	setPrettyPrintBody(Boolean prettyPrintBody)	Set whether to pretty print body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpLoggingProperties

public HttpLoggingProperties()

Creates an instance of HttpLoggingProperties.

Method Details

getLevel

public com.azure.core.http.policy.HttpLogDetailLevel getLevel()

Description copied from interface: HttpLoggingOptionsProvider.HttpLoggingOptions

Gets the level of detail to log on HTTP messages.

Specified by:

getLevel in interface HttpLoggingOptionsProvider.HttpLoggingOptions

Returns:

the http log detail level.

setLevel

public void setLevel(com.azure.core.http.policy.HttpLogDetailLevel level)

Set the logging detail level.

Parameters:

level - The logging detail level.

getAllowedHeaderNames

public Set<String> getAllowedHeaderNames()

Description copied from interface: HttpLoggingOptionsProvider.HttpLoggingOptions

Gets the allowlist headers that should be logged.

Specified by:

getAllowedHeaderNames in interface HttpLoggingOptionsProvider.HttpLoggingOptions

Returns:

The list of allowlist headers.

getAllowedQueryParamNames

public Set<String> getAllowedQueryParamNames()

Description copied from interface: HttpLoggingOptionsProvider.HttpLoggingOptions

Gets the allowlist query parameters.

Specified by:

getAllowedQueryParamNames in interface HttpLoggingOptionsProvider.HttpLoggingOptions

Returns:

The list of allowlist query parameters.

getPrettyPrintBody

public Boolean getPrettyPrintBody()

Description copied from interface: HttpLoggingOptionsProvider.HttpLoggingOptions

Gets flag to allow pretty printing of message bodies.

Specified by:

getPrettyPrintBody in interface HttpLoggingOptionsProvider.HttpLoggingOptions

Returns:

whether to pretty print the message bodies.

setPrettyPrintBody

public void setPrettyPrintBody(Boolean prettyPrintBody)

Set whether to pretty print body.

Parameters:

prettyPrintBody - Whether to pretty print body.