kuery-client-core/dev.hsbrysk.kuery.core.observation/KueryClientObservationDocumentation

KueryClientObservationDocumentation

enum KueryClientObservationDocumentation : ObservationDocumentation, Enum<KueryClientObservationDocumentation> (source)

ObservationDocumentation for the observations recorded by KueryClient and KueryBlockingClient.

Entries

The observation recorded for each fetch (i.e. each terminal operation of a FetchSpec), named kuery.client.fetches by default.

Properties

contextualName

open val contextualName: @Nullable String?

defaultConvention

open val defaultConvention: @Nullable Class<out ObservationConvention<out Observation.Context?>?>?

entries

val entries: EnumEntries<KueryClientObservationDocumentation>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

events

open val events: Array<out Observation.Event?>?

highCardinalityKeyNames

open val highCardinalityKeyNames: Array<out KeyName?>?

lowCardinalityKeyNames

open val lowCardinalityKeyNames: Array<out KeyName?>?

name

open val name: @Nullable String?

val name: String

ordinal

val ordinal: Int

prefix

open val prefix: String?

Functions

observation

open fun observation(registry: ObservationRegistry?): Observation?

open fun observation(registry: ObservationRegistry?, contextSupplier: Supplier<Observation.Context?>?): Observation?

open fun <T : Observation.Context?> observation(customConvention: @Nullable ObservationConvention<T?>?, defaultConvention: ObservationConvention<T?>?, contextSupplier: Supplier<T?>?, registry: ObservationRegistry?): Observation?

start

open fun start(registry: ObservationRegistry?): Observation?

open fun start(registry: ObservationRegistry?, contextSupplier: Supplier<Observation.Context?>?): Observation?

open fun <T : Observation.Context?> start(customConvention: @Nullable ObservationConvention<T?>?, defaultConvention: ObservationConvention<T?>?, contextSupplier: Supplier<T?>?, registry: ObservationRegistry?): Observation?

valueOf

fun valueOf(value: String): KueryClientObservationDocumentation

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.)

values

fun values(): Array<KueryClientObservationDocumentation>

Returns an array containing the constants of this enum type, in the order they're declared.