jenkins.metrics.api

Interface MetricsAccessKey.Provider

All Superinterfaces:

hudson.ExtensionPoint, Serializable

All Known Implementing Classes:

MetricsAccessKey.AbstractProvider, MetricsAccessKey.FixedListProviderImpl

Enclosing class:

MetricsAccessKey

public static interface MetricsAccessKey.Provider
extends hudson.ExtensionPoint, Serializable

An extension point that allows for plugins to provide their own set of access keys.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Methods

Modifier and Type	Method and Description
MetricsAccessKey	getAccessKey(String accessKey) Returns the definition of the specific access key.
List<MetricsAccessKey>	getAccessKeys()

Method Detail

getAccessKeys

@NonNull
List<MetricsAccessKey> getAccessKeys()

getAccessKey

@CheckForNull
MetricsAccessKey getAccessKey(String accessKey)

Returns the definition of the specific access key. Note that all entries in getAccessKeys() must be returned by this method, but it may also return additional entries.

Parameters:

accessKey - the access key to retrieve.

Returns:

the access key.