Class HealthChecksService.HealthChecksServiceClient
Namespace: ArmoniK.Api.gRPC.V1.HealthChecks
Assembly: ArmoniK.Api.Client.dll, ArmoniK.Api.Core.dll
Client for HealthChecksService
public class HealthChecksService.HealthChecksServiceClient : ClientBase<HealthChecksService.HealthChecksServiceClient>
Inheritance
object ← ClientBase ← ClientBase<HealthChecksService.HealthChecksServiceClient> ← HealthChecksService.HealthChecksServiceClient
Inherited Members
ClientBase<HealthChecksService.HealthChecksServiceClient>.WithHost(string), ClientBase<HealthChecksService.HealthChecksServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration), ClientBase.CallInvoker, object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()
Constructors
HealthChecksServiceClient(ChannelBase)
Creates a new client for HealthChecksService
public HealthChecksServiceClient(ChannelBase channel)
Parameters
channel ChannelBase
The channel to use to make remote calls.
HealthChecksServiceClient(CallInvoker)
Creates a new client for HealthChecksService that uses a custom CallInvoker.
public HealthChecksServiceClient(CallInvoker callInvoker)
Parameters
callInvoker CallInvoker
The callInvoker to use to make remote calls.
HealthChecksServiceClient()
Protected parameterless constructor to allow creation of test doubles.
protected HealthChecksServiceClient()
HealthChecksServiceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
protected HealthChecksServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
The client configuration.
HealthChecksServiceClient(ChannelBase)
Creates a new client for HealthChecksService
public HealthChecksServiceClient(ChannelBase channel)
Parameters
channel ChannelBase
The channel to use to make remote calls.
HealthChecksServiceClient(CallInvoker)
Creates a new client for HealthChecksService that uses a custom CallInvoker.
public HealthChecksServiceClient(CallInvoker callInvoker)
Parameters
callInvoker CallInvoker
The callInvoker to use to make remote calls.
HealthChecksServiceClient()
Protected parameterless constructor to allow creation of test doubles.
protected HealthChecksServiceClient()
HealthChecksServiceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
protected HealthChecksServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
The client configuration.
Methods
CheckHealth(CheckHealthRequest, Metadata, DateTime?, CancellationToken)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual CheckHealthResponse CheckHealth(CheckHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CheckHealthRequest
The request to send to the server.
headers Metadata
The initial metadata to send with the call. This parameter is optional.
deadline DateTime?
An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken
An optional token for canceling the call.
Returns
The response received from the server.
CheckHealth(CheckHealthRequest, CallOptions)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual CheckHealthResponse CheckHealth(CheckHealthRequest request, CallOptions options)
Parameters
request CheckHealthRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
CheckHealth(CheckHealthRequest, Metadata, DateTime?, CancellationToken)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual CheckHealthResponse CheckHealth(CheckHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CheckHealthRequest
The request to send to the server.
headers Metadata
The initial metadata to send with the call. This parameter is optional.
deadline DateTime?
An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken
An optional token for canceling the call.
Returns
CheckHealthResponse
The response received from the server.
CheckHealth(CheckHealthRequest, CallOptions)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual CheckHealthResponse CheckHealth(CheckHealthRequest request, CallOptions options)
Parameters
request CheckHealthRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
CheckHealthResponse
The response received from the server.
CheckHealthAsync(CheckHealthRequest, Metadata, DateTime?, CancellationToken)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual AsyncUnaryCall<CheckHealthResponse> CheckHealthAsync(CheckHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CheckHealthRequest
The request to send to the server.
headers Metadata
The initial metadata to send with the call. This parameter is optional.
deadline DateTime?
An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken
An optional token for canceling the call.
Returns
AsyncUnaryCall<CheckHealthResponse>
The call object.
CheckHealthAsync(CheckHealthRequest, CallOptions)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual AsyncUnaryCall<CheckHealthResponse> CheckHealthAsync(CheckHealthRequest request, CallOptions options)
Parameters
request CheckHealthRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CheckHealthResponse>
The call object.
CheckHealthAsync(CheckHealthRequest, Metadata, DateTime?, CancellationToken)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual AsyncUnaryCall<CheckHealthResponse> CheckHealthAsync(CheckHealthRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CheckHealthRequest
The request to send to the server.
headers Metadata
The initial metadata to send with the call. This parameter is optional.
deadline DateTime?
An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken
An optional token for canceling the call.
Returns
AsyncUnaryCall<CheckHealthResponse>
The call object.
CheckHealthAsync(CheckHealthRequest, CallOptions)
Checks the health of the cluster. This can be used to verify that the cluster is up and running.
public virtual AsyncUnaryCall<CheckHealthResponse> CheckHealthAsync(CheckHealthRequest request, CallOptions options)
Parameters
request CheckHealthRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CheckHealthResponse>
The call object.
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
protected override HealthChecksService.HealthChecksServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
Returns
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
protected override HealthChecksService.HealthChecksServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration