com.microsoft.rest

Enum LogLevel

java.lang.Object

java.lang.Enum<LogLevel>

com.microsoft.rest.LogLevel

All Implemented Interfaces:

Serializable, Comparable<LogLevel>

public enum LogLevel
extends Enum<LogLevel>

Describes the level of HTTP traffic to log.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC Logs only URLs, HTTP methods, and time to finish the request.
BODY Logs everything in BASIC, plus all the request and response body.
BODY_AND_HEADERS Logs everything in HEADERS and BODY.
HEADERS Logs everything in BASIC, plus all the request and response headers.
NONE Logging is turned off.

Method Summary

Modifier and Type	Method and Description
boolean	isPrettyJson()
static LogLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static LogLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
LogLevel	withPrettyJson(boolean prettyJson) Specifies whether to log prettified JSON.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final LogLevel NONE

Logging is turned off.

BASIC

public static final LogLevel BASIC

Logs only URLs, HTTP methods, and time to finish the request.

HEADERS

public static final LogLevel HEADERS

Logs everything in BASIC, plus all the request and response headers.

BODY

public static final LogLevel BODY

Logs everything in BASIC, plus all the request and response body. Note that only payloads in plain text or plan text encoded in GZIP will be logged.

BODY_AND_HEADERS

public static final LogLevel BODY_AND_HEADERS

Logs everything in HEADERS and BODY.

Method Detail

values

public static LogLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LogLevel c : LogLevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LogLevel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isPrettyJson

public boolean isPrettyJson()

Returns:

if the JSON payloads will be prettified when log level is set to BODY or BODY_AND_HEADERS. Default is false.

withPrettyJson

public LogLevel withPrettyJson(boolean prettyJson)

Specifies whether to log prettified JSON.

Parameters:

prettyJson - true if JSON paylods are prettified.

Returns:

the enum object