software.amazon.lambda.powertools.tracing

Enum CaptureMode

java.lang.Object

java.lang.Enum<CaptureMode>

software.amazon.lambda.powertools.tracing.CaptureMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CaptureMode>

public enum CaptureMode
extends java.lang.Enum<CaptureMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Disables annotation to capture both response and error from the method.
ENVIRONMENT_VAR Enables/Disables annotation to capture response and error from the method based on the value of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR
ERROR Enabled annotation to capture only error from the method.
RESPONSE Enables annotation to capture only response.
RESPONSE_AND_ERROR Enabled annotation to capture both response error from the method.

Method Summary

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

RESPONSE

public static final CaptureMode RESPONSE

Enables annotation to capture only response. If this mode is explicitly overridden on Tracing annotation, it will override value of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE

ERROR

public static final CaptureMode ERROR

Enabled annotation to capture only error from the method. If this mode is explicitly overridden on Tracing annotation, it will override value of environment variable POWERTOOLS_TRACER_CAPTURE_ERROR

RESPONSE_AND_ERROR

public static final CaptureMode RESPONSE_AND_ERROR

Enabled annotation to capture both response error from the method. If this mode is explicitly overridden on Tracing annotation, it will override value of environment variables POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR

DISABLED

public static final CaptureMode DISABLED

Disables annotation to capture both response and error from the method. If this mode is explicitly overridden on Tracing annotation, it will override values of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR

ENVIRONMENT_VAR

public static final CaptureMode ENVIRONMENT_VAR

Enables/Disables annotation to capture response and error from the method based on the value of environment variable POWERTOOLS_TRACER_CAPTURE_RESPONSE and POWERTOOLS_TRACER_CAPTURE_ERROR

Method Detail

values

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

Returns:

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

valueOf

public static CaptureMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null