spring-boot/org.springframework.boot.web.error/ErrorAttributeOptions

ErrorAttributeOptions

class ErrorAttributeOptions

Options controlling the contents of ErrorAttributes.

Author

Scott Frederick

Phillip Webb

Since

2.3.0

Types

Link copied to clipboard
enum Include
Error attributes that can be included in an error response.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
open fun defaults(): ErrorAttributeOptions
Create an ErrorAttributeOptions with defaults.
Link copied to clipboard
open fun excluding(excludes: Array<ErrorAttributeOptions.Include>): ErrorAttributeOptions
Return an ErrorAttributeOptions that excludes the specified attribute Include options.
Link copied to clipboard
open fun including(includes: Array<ErrorAttributeOptions.Include>): ErrorAttributeOptions
Return an ErrorAttributeOptions that includes the specified attribute Include options.
Link copied to clipboard
open fun isIncluded(include: ErrorAttributeOptions.Include): Boolean
Get the option for including the specified attribute in the error response.
Link copied to clipboard
open fun of(includes: Collection<ErrorAttributeOptions.Include>): ErrorAttributeOptions
open fun of(includes: Array<ErrorAttributeOptions.Include>): ErrorAttributeOptions
Create an ErrorAttributeOptions that includes the specified attribute Include options.
Link copied to clipboard
open fun retainIncluded(map: Map<String, Any>)
Remove elements from the given map if they are not included in this set of options.