Skip to content

Opensearch dashboards.requesthandlercontext

Home > opensearch-dashboards > RequestHandlerContext

RequestHandlerContext interface

Plugin specific context passed to a route handler.

Provides the following clients and services: - savedObjects.client - Saved Objects client which uses the credentials of the incoming request - savedObjects.typeRegistry - Type registry containing all the registered types. - opensearch.client - OpenSearch data client which uses the credentials of the incoming request - opensearch.legacy.client - The legacy OpenSearch data client which uses the credentials of the incoming request - uiSettings.client - uiSettings client which uses the credentials of the incoming request - uiSettings.auditor - AuditTrail client scoped to the incoming request

Signature:

export interface RequestHandlerContext 

Properties

Property Type Description
core { savedObjects: { client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; }; opensearch: { client: IScopedClusterClient; legacy: { client: ILegacyScopedClusterClient; }; }; uiSettings: { client: IUiSettingsClient; }; auditor: Auditor; }