Opensearch dashboards.iclusterclient
Home > opensearch-dashboards > IClusterClient
IClusterClient interface
Represents an OpenSearch cluster API client created by the platform. It allows to call API on behalf of the internal OpenSearch Dashboards user and the actual user that is derived from the request headers (via asScoped(...)
).
Signature:
export interface IClusterClient
Properties
Property | Type | Description |
---|---|---|
asInternalUser | OpenSearchClient | A client to be used to query the OpenSearch cluster on behalf of the OpenSearch Dashboards internal user |
asScoped | (request: ScopeableRequest) => IScopedClusterClient | Creates a scoped cluster client bound to given request |