Top Description Inners Fields Constructors Methods
org.springframework.scheduling.support

public sealed Enum ScheduledTaskObservationDocumentation

extends Enum<ScheduledTaskObservationDocumentation>
implements ObservationDocumentation
Class Inheritance
All Implemented Interfaces
io.micrometer.observation.docs.ObservationDocumentation
Imports
io.micrometer.common.KeyValue, io.micrometer.common.docs.KeyName, io.micrometer.observation.Observation, .ObservationConvention, io.micrometer.observation.docs.ObservationDocumentation
Documented KeyValues for the observations on executions of scheduled tasks

This class is used by automated tools to document KeyValues attached to the @Scheduled observations.

Author
Brian Clozel
Since
6.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ScheduledTaskObservationDocumentation.LowCardinalityKeyNames

Field Summary

Modifier and TypeField and Description
public static final ScheduledTaskObservationDocumentation
TASKS_SCHEDULED_EXECUTION

Observations on executions of org.springframework.scheduling.annotation.Scheduled tasks.

Constructor Summary

AccessConstructor and Description
private
ScheduledTaskObservationDocumentation()

Method Summary

Modifier and TypeMethod and Description
public static ScheduledTaskObservationDocumentation
valueOf(String name)

public static ScheduledTaskObservationDocumentation[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

TASKS_SCHEDULED_EXECUTIONback to summary
public static final ScheduledTaskObservationDocumentation TASKS_SCHEDULED_EXECUTION

Observations on executions of org.springframework.scheduling.annotation.Scheduled tasks.

Constructor Detail

ScheduledTaskObservationDocumentationback to summary
private ScheduledTaskObservationDocumentation()

Method Detail

valueOfback to summary
public static ScheduledTaskObservationDocumentation valueOf(String name)
valuesback to summary
public static ScheduledTaskObservationDocumentation[] values()
org.springframework.scheduling.support back to summary

public sealed Enum ScheduledTaskObservationDocumentation.LowCardinalityKeyNames

extends Enum<ScheduledTaskObservationDocumentation.LowCardinalityKeyNames>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames
CODE_FUNCTION

Name of the method that is executed for the scheduled task.

public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames
CODE_NAMESPACE

Canonical name of the target type that owns the scheduled method.

public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames
EXCEPTION

Name of the exception thrown during task execution, or none if no exception was thrown.

public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames
OUTCOME

Outcome of the scheduled task execution.

Constructor Summary

AccessConstructor and Description
private
LowCardinalityKeyNames()

Method Summary

Modifier and TypeMethod and Description
public static ScheduledTaskObservationDocumentation.LowCardinalityKeyNames
valueOf(String name)

public static ScheduledTaskObservationDocumentation.LowCardinalityKeyNames[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CODE_FUNCTIONback to summary
public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames CODE_FUNCTION

Name of the method that is executed for the scheduled task.

CODE_NAMESPACEback to summary
public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames CODE_NAMESPACE

Canonical name of the target type that owns the scheduled method.

EXCEPTIONback to summary
public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames EXCEPTION

Name of the exception thrown during task execution, or none if no exception was thrown.

OUTCOMEback to summary
public static final ScheduledTaskObservationDocumentation.LowCardinalityKeyNames OUTCOME

Outcome of the scheduled task execution.

Constructor Detail

LowCardinalityKeyNamesback to summary
private LowCardinalityKeyNames()

Method Detail

valueOfback to summary
public static ScheduledTaskObservationDocumentation.LowCardinalityKeyNames valueOf(String name)
valuesback to summary
public static ScheduledTaskObservationDocumentation.LowCardinalityKeyNames[] values()