Class Events.EventsClient

Namespace: ArmoniK.Api.gRPC.V1.Events
Assembly: ArmoniK.Api.Client.dll, ArmoniK.Api.Core.dll

Client for Events

public class Events.EventsClient : ClientBase<Events.EventsClient>

Inheritance

objectClientBaseClientBase<Events.EventsClient>Events.EventsClient

Inherited Members

ClientBase<Events.EventsClient>.WithHost(string), ClientBase<Events.EventsClient>.NewInstance(ClientBase.ClientBaseConfiguration), ClientBase.CallInvoker, object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Extension Methods

EventsClientExt.WaitForResultsAsync(Events.EventsClient, string, ICollection<string>, CancellationToken), EventsClientExt.WaitForResultsAsync(Events.EventsClient, string, ICollection<string>, int, int, CancellationToken)

Constructors

EventsClient(ChannelBase)

Creates a new client for Events

public EventsClient(ChannelBase channel)

Parameters

channel ChannelBase

The channel to use to make remote calls.

EventsClient(CallInvoker)

Creates a new client for Events that uses a custom CallInvoker.

public EventsClient(CallInvoker callInvoker)

Parameters

callInvoker CallInvoker

The callInvoker to use to make remote calls.

EventsClient()

Protected parameterless constructor to allow creation of test doubles.

protected EventsClient()

EventsClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

protected EventsClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

The client configuration.

EventsClient(ChannelBase)

Creates a new client for Events

public EventsClient(ChannelBase channel)

Parameters

channel ChannelBase

The channel to use to make remote calls.

EventsClient(CallInvoker)

Creates a new client for Events that uses a custom CallInvoker.

public EventsClient(CallInvoker callInvoker)

Parameters

callInvoker CallInvoker

The callInvoker to use to make remote calls.

EventsClient()

Protected parameterless constructor to allow creation of test doubles.

protected EventsClient()

EventsClient(ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

protected EventsClient(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

GetEvents(EventSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Get events that represents updates of result and tasks data.

public virtual AsyncServerStreamingCall<EventSubscriptionResponse> GetEvents(EventSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request EventSubscriptionRequest

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

AsyncServerStreamingCall<EventSubscriptionResponse>

The call object.

GetEvents(EventSubscriptionRequest, CallOptions)

Get events that represents updates of result and tasks data.

public virtual AsyncServerStreamingCall<EventSubscriptionResponse> GetEvents(EventSubscriptionRequest request, CallOptions options)

Parameters

request EventSubscriptionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns

AsyncServerStreamingCall<EventSubscriptionResponse>

The call object.

GetEvents(EventSubscriptionRequest, Metadata, DateTime?, CancellationToken)

Get events that represents updates of result and tasks data.

public virtual AsyncServerStreamingCall<EventSubscriptionResponse> GetEvents(EventSubscriptionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Parameters

request EventSubscriptionRequest

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

AsyncServerStreamingCall<EventSubscriptionResponse>

The call object.

GetEvents(EventSubscriptionRequest, CallOptions)

Get events that represents updates of result and tasks data.

public virtual AsyncServerStreamingCall<EventSubscriptionResponse> GetEvents(EventSubscriptionRequest request, CallOptions options)

Parameters

request EventSubscriptionRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns

AsyncServerStreamingCall<EventSubscriptionResponse>

The call object.

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

protected override Events.EventsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

Returns

Events.EventsClient

NewInstance(ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

protected override Events.EventsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Parameters

configuration ClientBase.ClientBaseConfiguration

Returns

Events.EventsClient