Opensearch dashboards.opensearchdashboardsrequest
Home > opensearch-dashboards > OpenSearchDashboardsRequest
OpenSearchDashboardsRequest class
OpenSearch Dashboards specific abstraction for an incoming request.
Signature:
export declare class OpenSearchDashboardsRequest<Params = unknown, Query = unknown, Body = unknown, Method extends RouteMethod = any>
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(request, params, query, body, withoutSecretHeaders) | Constructs a new instance of the OpenSearchDashboardsRequest class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
auth | { isAuthenticated: boolean; } | ||
body | Body | ||
events | OpenSearchDashboardsRequestEvents | Request events OpenSearchDashboardsRequestEvents | |
headers | Headers | Readonly copy of incoming request headers. | |
id | string | A identifier to identify this request. | |
isSystemRequest | boolean | Whether or not the request is a "system request" rather than an application-level request. Can be set on the client using the HttpFetchOptions#asSystemRequest option. |
|
params | Params | ||
query | Query | ||
route | RecursiveReadonly<OpenSearchDashboardsRequestRoute<Method>> | matched route details | |
socket | IOpenSearchDashboardsSocket | IOpenSearchDashboardsSocket | |
url | URL | a WHATWG URL standard object. | |
uuid | string | A UUID to identify this request. |