Interface IHealthClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Health and identity operations.

public interface IHealthClient

Methods

CheckAsync(CancellationToken)

Checks that the gateway is reachable and reports its status.

ValueTask<HealthResult> CheckAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<HealthResult>

GetCurrentUserAsync(CancellationToken)

Gets the identity the gateway sees for the current credentials.

ValueTask<CurrentUser> GetCurrentUserAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<CurrentUser>

GetGatewayInfoAsync(CancellationToken)

Gets gateway version, compute drivers and negotiated extensions.

ValueTask<GatewayInfo> GetGatewayInfoAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<GatewayInfo>