io.apimatic.core.configurations.http.client

Enum ApiLoggingConfiguration.HeaderLoggingPolicy

java.lang.Object

java.lang.Enum<ApiLoggingConfiguration.HeaderLoggingPolicy>

io.apimatic.core.configurations.http.client.ApiLoggingConfiguration.HeaderLoggingPolicy

All Implemented Interfaces:

Serializable, Comparable<ApiLoggingConfiguration.HeaderLoggingPolicy>

Enclosing class:

ApiLoggingConfiguration

public static enum ApiLoggingConfiguration.HeaderLoggingPolicy
extends Enum<ApiLoggingConfiguration.HeaderLoggingPolicy>

HeaderLoggingPolicy enum to use with headerLoggingPolicy in ApiLoggingConfiguration.Builder. It is either used to exclude or include headers provided in header filters, for various security reasons.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCLUDE Policy that only exclude the headerFilters from headers.
INCLUDE Policy that only include the headerFilters as headers.

Method Summary

Modifier and Type	Method and Description
static ApiLoggingConfiguration.HeaderLoggingPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiLoggingConfiguration.HeaderLoggingPolicy[]	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

INCLUDE

public static final ApiLoggingConfiguration.HeaderLoggingPolicy INCLUDE

Policy that only include the headerFilters as headers. So all the headers that are not provided in header filters will be excluded.

EXCLUDE

public static final ApiLoggingConfiguration.HeaderLoggingPolicy EXCLUDE

Policy that only exclude the headerFilters from headers. So all the headers that are not provided in header filters will be included.

Method Detail

values

public static ApiLoggingConfiguration.HeaderLoggingPolicy[] 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 (ApiLoggingConfiguration.HeaderLoggingPolicy c : ApiLoggingConfiguration.HeaderLoggingPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static ApiLoggingConfiguration.HeaderLoggingPolicy 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