Include (Spring Boot Docs 2.0.0.M7 API)

java.lang.Object
- java.lang.Enum<Include>
- - org.springframework.boot.actuate.trace.Include

All Implemented Interfaces:

Serializable, Comparable<Include>
```
public enum Include
extends Enum<Include>
```
Include options for tracing.

Since:

2.0.0

Author:

Wallace Wadge

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTH_TYPE` Include the authentication type.
`AUTHORIZATION_HEADER` Include authorization header (if any).
`CONTEXT_PATH` Include the context path.
`COOKIES` Include "Cookie" in request and "Set-Cookie" in response headers.
`ERRORS` Include errors (if any).
`PARAMETERS` Include the parameters.
`PATH_INFO` Include path info.
`PATH_TRANSLATED` Include the translated path.
`QUERY_STRING` Include the query string.
`REMOTE_ADDRESS` Include the remote address.
`REMOTE_USER` Include the remote user.
`REQUEST_HEADERS` Include request headers.
`RESPONSE_HEADERS` Include response headers.
`SESSION_ID` Include the session ID.
`TIME_TAKEN` Include the time taken to service the request in milliseconds.
`USER_PRINCIPAL` Include the user principal.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Set<Include>`	`defaultIncludes()` Return the default `Include`.
`static Include`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Include[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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
  - REQUEST_HEADERS
```
public static final Include REQUEST_HEADERS
```
    Include request headers.
  - RESPONSE_HEADERS
```
public static final Include RESPONSE_HEADERS
```
    Include response headers.
  - COOKIES
```
public static final Include COOKIES
```
    Include "Cookie" in request and "Set-Cookie" in response headers.
  - AUTHORIZATION_HEADER
```
public static final Include AUTHORIZATION_HEADER
```
    Include authorization header (if any).
  - ERRORS
```
public static final Include ERRORS
```
    Include errors (if any).
  - PATH_INFO
```
public static final Include PATH_INFO
```
    Include path info.
  - PATH_TRANSLATED
```
public static final Include PATH_TRANSLATED
```
    Include the translated path.
  - CONTEXT_PATH
```
public static final Include CONTEXT_PATH
```
    Include the context path.
  - USER_PRINCIPAL
```
public static final Include USER_PRINCIPAL
```
    Include the user principal.
  - PARAMETERS
```
public static final Include PARAMETERS
```
    Include the parameters.
  - QUERY_STRING
```
public static final Include QUERY_STRING
```
    Include the query string.
  - AUTH_TYPE
```
public static final Include AUTH_TYPE
```
    Include the authentication type.
  - REMOTE_ADDRESS
```
public static final Include REMOTE_ADDRESS
```
    Include the remote address.
  - SESSION_ID
```
public static final Include SESSION_ID
```
    Include the session ID.
  - REMOTE_USER
```
public static final Include REMOTE_USER
```
    Include the remote user.
  - TIME_TAKEN
```
public static final Include TIME_TAKEN
```
    Include the time taken to service the request in milliseconds.
- Method Detail
  - values
```
public static Include[] 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 (Include c : Include.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Include 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
  - defaultIncludes
```
public static Set<Include> defaultIncludes()
```
    Return the default Include.
    
    Returns:
    
    the default include.

Enum Include

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

REQUEST_HEADERS

RESPONSE_HEADERS

COOKIES

AUTHORIZATION_HEADER

ERRORS

PATH_INFO

PATH_TRANSLATED

CONTEXT_PATH

USER_PRINCIPAL

PARAMETERS

QUERY_STRING

AUTH_TYPE

REMOTE_ADDRESS

SESSION_ID

REMOTE_USER

TIME_TAKEN

Method Detail

values

valueOf

defaultIncludes