Class Sessions.SessionsClient
Namespace: ArmoniK.Api.gRPC.V1.Sessions
Assembly: ArmoniK.Api.Client.dll, ArmoniK.Api.Core.dll
Client for Sessions
public class Sessions.SessionsClient : ClientBase<Sessions.SessionsClient>
Inheritance
object ← ClientBase ← ClientBase<Sessions.SessionsClient> ← Sessions.SessionsClient
Inherited Members
ClientBase<Sessions.SessionsClient>.WithHost(string), ClientBase<Sessions.SessionsClient>.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
SessionsClient(ChannelBase)
Creates a new client for Sessions
public SessionsClient(ChannelBase channel)
Parameters
channel ChannelBase
The channel to use to make remote calls.
SessionsClient(CallInvoker)
Creates a new client for Sessions that uses a custom CallInvoker.
public SessionsClient(CallInvoker callInvoker)
Parameters
callInvoker CallInvoker
The callInvoker to use to make remote calls.
SessionsClient()
Protected parameterless constructor to allow creation of test doubles.
protected SessionsClient()
SessionsClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
protected SessionsClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
The client configuration.
SessionsClient(ChannelBase)
Creates a new client for Sessions
public SessionsClient(ChannelBase channel)
Parameters
channel ChannelBase
The channel to use to make remote calls.
SessionsClient(CallInvoker)
Creates a new client for Sessions that uses a custom CallInvoker.
public SessionsClient(CallInvoker callInvoker)
Parameters
callInvoker CallInvoker
The callInvoker to use to make remote calls.
SessionsClient()
Protected parameterless constructor to allow creation of test doubles.
protected SessionsClient()
SessionsClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
protected SessionsClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
The client configuration.
Methods
CancelSession(CancelSessionRequest, Metadata, DateTime?, CancellationToken)
Cancel a session by its id.
public virtual CancelSessionResponse CancelSession(CancelSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CancelSessionRequest
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.
CancelSession(CancelSessionRequest, CallOptions)
Cancel a session by its id.
public virtual CancelSessionResponse CancelSession(CancelSessionRequest request, CallOptions options)
Parameters
request CancelSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
CancelSession(CancelSessionRequest, Metadata, DateTime?, CancellationToken)
Cancel a session by its id.
public virtual CancelSessionResponse CancelSession(CancelSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CancelSessionRequest
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
CancelSessionResponse
The response received from the server.
CancelSession(CancelSessionRequest, CallOptions)
Cancel a session by its id.
public virtual CancelSessionResponse CancelSession(CancelSessionRequest request, CallOptions options)
Parameters
request CancelSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
CancelSessionResponse
The response received from the server.
CancelSessionAsync(CancelSessionRequest, Metadata, DateTime?, CancellationToken)
Cancel a session by its id.
public virtual AsyncUnaryCall<CancelSessionResponse> CancelSessionAsync(CancelSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CancelSessionRequest
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<CancelSessionResponse>
The call object.
CancelSessionAsync(CancelSessionRequest, CallOptions)
Cancel a session by its id.
public virtual AsyncUnaryCall<CancelSessionResponse> CancelSessionAsync(CancelSessionRequest request, CallOptions options)
Parameters
request CancelSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CancelSessionResponse>
The call object.
CancelSessionAsync(CancelSessionRequest, Metadata, DateTime?, CancellationToken)
Cancel a session by its id.
public virtual AsyncUnaryCall<CancelSessionResponse> CancelSessionAsync(CancelSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CancelSessionRequest
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<CancelSessionResponse>
The call object.
CancelSessionAsync(CancelSessionRequest, CallOptions)
Cancel a session by its id.
public virtual AsyncUnaryCall<CancelSessionResponse> CancelSessionAsync(CancelSessionRequest request, CallOptions options)
Parameters
request CancelSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CancelSessionResponse>
The call object.
CloseSession(CloseSessionRequest, Metadata, DateTime?, CancellationToken)
Close a session by its id..
public virtual CloseSessionResponse CloseSession(CloseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CloseSessionRequest
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.
CloseSession(CloseSessionRequest, CallOptions)
Close a session by its id..
public virtual CloseSessionResponse CloseSession(CloseSessionRequest request, CallOptions options)
Parameters
request CloseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
CloseSession(CloseSessionRequest, Metadata, DateTime?, CancellationToken)
Close a session by its id..
public virtual CloseSessionResponse CloseSession(CloseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CloseSessionRequest
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
CloseSessionResponse
The response received from the server.
CloseSession(CloseSessionRequest, CallOptions)
Close a session by its id..
public virtual CloseSessionResponse CloseSession(CloseSessionRequest request, CallOptions options)
Parameters
request CloseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
CloseSessionResponse
The response received from the server.
CloseSessionAsync(CloseSessionRequest, Metadata, DateTime?, CancellationToken)
Close a session by its id..
public virtual AsyncUnaryCall<CloseSessionResponse> CloseSessionAsync(CloseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CloseSessionRequest
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<CloseSessionResponse>
The call object.
CloseSessionAsync(CloseSessionRequest, CallOptions)
Close a session by its id..
public virtual AsyncUnaryCall<CloseSessionResponse> CloseSessionAsync(CloseSessionRequest request, CallOptions options)
Parameters
request CloseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CloseSessionResponse>
The call object.
CloseSessionAsync(CloseSessionRequest, Metadata, DateTime?, CancellationToken)
Close a session by its id..
public virtual AsyncUnaryCall<CloseSessionResponse> CloseSessionAsync(CloseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CloseSessionRequest
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<CloseSessionResponse>
The call object.
CloseSessionAsync(CloseSessionRequest, CallOptions)
Close a session by its id..
public virtual AsyncUnaryCall<CloseSessionResponse> CloseSessionAsync(CloseSessionRequest request, CallOptions options)
Parameters
request CloseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CloseSessionResponse>
The call object.
CreateSession(CreateSessionRequest, Metadata, DateTime?, CancellationToken)
Create a session
public virtual CreateSessionReply CreateSession(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CreateSessionRequest
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.
CreateSession(CreateSessionRequest, CallOptions)
Create a session
public virtual CreateSessionReply CreateSession(CreateSessionRequest request, CallOptions options)
Parameters
request CreateSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
CreateSession(CreateSessionRequest, Metadata, DateTime?, CancellationToken)
Create a session
public virtual CreateSessionReply CreateSession(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CreateSessionRequest
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
CreateSessionReply
The response received from the server.
CreateSession(CreateSessionRequest, CallOptions)
Create a session
public virtual CreateSessionReply CreateSession(CreateSessionRequest request, CallOptions options)
Parameters
request CreateSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
CreateSessionReply
The response received from the server.
CreateSessionAsync(CreateSessionRequest, Metadata, DateTime?, CancellationToken)
Create a session
public virtual AsyncUnaryCall<CreateSessionReply> CreateSessionAsync(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CreateSessionRequest
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<CreateSessionReply>
The call object.
CreateSessionAsync(CreateSessionRequest, CallOptions)
Create a session
public virtual AsyncUnaryCall<CreateSessionReply> CreateSessionAsync(CreateSessionRequest request, CallOptions options)
Parameters
request CreateSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CreateSessionReply>
The call object.
CreateSessionAsync(CreateSessionRequest, Metadata, DateTime?, CancellationToken)
Create a session
public virtual AsyncUnaryCall<CreateSessionReply> CreateSessionAsync(CreateSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request CreateSessionRequest
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<CreateSessionReply>
The call object.
CreateSessionAsync(CreateSessionRequest, CallOptions)
Create a session
public virtual AsyncUnaryCall<CreateSessionReply> CreateSessionAsync(CreateSessionRequest request, CallOptions options)
Parameters
request CreateSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<CreateSessionReply>
The call object.
DeleteSession(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual DeleteSessionResponse DeleteSession(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request DeleteSessionRequest
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.
DeleteSession(DeleteSessionRequest, CallOptions)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual DeleteSessionResponse DeleteSession(DeleteSessionRequest request, CallOptions options)
Parameters
request DeleteSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
DeleteSession(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual DeleteSessionResponse DeleteSession(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request DeleteSessionRequest
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
DeleteSessionResponse
The response received from the server.
DeleteSession(DeleteSessionRequest, CallOptions)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual DeleteSessionResponse DeleteSession(DeleteSessionRequest request, CallOptions options)
Parameters
request DeleteSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
DeleteSessionResponse
The response received from the server.
DeleteSessionAsync(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual AsyncUnaryCall<DeleteSessionResponse> DeleteSessionAsync(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request DeleteSessionRequest
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<DeleteSessionResponse>
The call object.
DeleteSessionAsync(DeleteSessionRequest, CallOptions)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual AsyncUnaryCall<DeleteSessionResponse> DeleteSessionAsync(DeleteSessionRequest request, CallOptions options)
Parameters
request DeleteSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<DeleteSessionResponse>
The call object.
DeleteSessionAsync(DeleteSessionRequest, Metadata, DateTime?, CancellationToken)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual AsyncUnaryCall<DeleteSessionResponse> DeleteSessionAsync(DeleteSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request DeleteSessionRequest
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<DeleteSessionResponse>
The call object.
DeleteSessionAsync(DeleteSessionRequest, CallOptions)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual AsyncUnaryCall<DeleteSessionResponse> DeleteSessionAsync(DeleteSessionRequest request, CallOptions options)
Parameters
request DeleteSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<DeleteSessionResponse>
The call object.
GetSession(GetSessionRequest, Metadata, DateTime?, CancellationToken)
Get a session by its id.
public virtual GetSessionResponse GetSession(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request GetSessionRequest
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.
GetSession(GetSessionRequest, CallOptions)
Get a session by its id.
public virtual GetSessionResponse GetSession(GetSessionRequest request, CallOptions options)
Parameters
request GetSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
GetSession(GetSessionRequest, Metadata, DateTime?, CancellationToken)
Get a session by its id.
public virtual GetSessionResponse GetSession(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request GetSessionRequest
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
GetSessionResponse
The response received from the server.
GetSession(GetSessionRequest, CallOptions)
Get a session by its id.
public virtual GetSessionResponse GetSession(GetSessionRequest request, CallOptions options)
Parameters
request GetSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
GetSessionResponse
The response received from the server.
GetSessionAsync(GetSessionRequest, Metadata, DateTime?, CancellationToken)
Get a session by its id.
public virtual AsyncUnaryCall<GetSessionResponse> GetSessionAsync(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request GetSessionRequest
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<GetSessionResponse>
The call object.
GetSessionAsync(GetSessionRequest, CallOptions)
Get a session by its id.
public virtual AsyncUnaryCall<GetSessionResponse> GetSessionAsync(GetSessionRequest request, CallOptions options)
Parameters
request GetSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<GetSessionResponse>
The call object.
GetSessionAsync(GetSessionRequest, Metadata, DateTime?, CancellationToken)
Get a session by its id.
public virtual AsyncUnaryCall<GetSessionResponse> GetSessionAsync(GetSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request GetSessionRequest
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<GetSessionResponse>
The call object.
GetSessionAsync(GetSessionRequest, CallOptions)
Get a session by its id.
public virtual AsyncUnaryCall<GetSessionResponse> GetSessionAsync(GetSessionRequest request, CallOptions options)
Parameters
request GetSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<GetSessionResponse>
The call object.
ListSessions(ListSessionsRequest, Metadata, DateTime?, CancellationToken)
Get a sessions list using pagination, filters and sorting.
public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ListSessionsRequest
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.
ListSessions(ListSessionsRequest, CallOptions)
Get a sessions list using pagination, filters and sorting.
public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, CallOptions options)
Parameters
request ListSessionsRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
ListSessions(ListSessionsRequest, Metadata, DateTime?, CancellationToken)
Get a sessions list using pagination, filters and sorting.
public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ListSessionsRequest
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
ListSessionsResponse
The response received from the server.
ListSessions(ListSessionsRequest, CallOptions)
Get a sessions list using pagination, filters and sorting.
public virtual ListSessionsResponse ListSessions(ListSessionsRequest request, CallOptions options)
Parameters
request ListSessionsRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
ListSessionsResponse
The response received from the server.
ListSessionsAsync(ListSessionsRequest, Metadata, DateTime?, CancellationToken)
Get a sessions list using pagination, filters and sorting.
public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ListSessionsRequest
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<ListSessionsResponse>
The call object.
ListSessionsAsync(ListSessionsRequest, CallOptions)
Get a sessions list using pagination, filters and sorting.
public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, CallOptions options)
Parameters
request ListSessionsRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<ListSessionsResponse>
The call object.
ListSessionsAsync(ListSessionsRequest, Metadata, DateTime?, CancellationToken)
Get a sessions list using pagination, filters and sorting.
public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ListSessionsRequest
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<ListSessionsResponse>
The call object.
ListSessionsAsync(ListSessionsRequest, CallOptions)
Get a sessions list using pagination, filters and sorting.
public virtual AsyncUnaryCall<ListSessionsResponse> ListSessionsAsync(ListSessionsRequest request, CallOptions options)
Parameters
request ListSessionsRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<ListSessionsResponse>
The call object.
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
protected override Sessions.SessionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
Returns
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration.
protected override Sessions.SessionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
configuration ClientBase.ClientBaseConfiguration
Returns
PauseSession(PauseSessionRequest, Metadata, DateTime?, CancellationToken)
Pause a session by its id.
public virtual PauseSessionResponse PauseSession(PauseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PauseSessionRequest
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.
PauseSession(PauseSessionRequest, CallOptions)
Pause a session by its id.
public virtual PauseSessionResponse PauseSession(PauseSessionRequest request, CallOptions options)
Parameters
request PauseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
PauseSession(PauseSessionRequest, Metadata, DateTime?, CancellationToken)
Pause a session by its id.
public virtual PauseSessionResponse PauseSession(PauseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PauseSessionRequest
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
PauseSessionResponse
The response received from the server.
PauseSession(PauseSessionRequest, CallOptions)
Pause a session by its id.
public virtual PauseSessionResponse PauseSession(PauseSessionRequest request, CallOptions options)
Parameters
request PauseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
PauseSessionResponse
The response received from the server.
PauseSessionAsync(PauseSessionRequest, Metadata, DateTime?, CancellationToken)
Pause a session by its id.
public virtual AsyncUnaryCall<PauseSessionResponse> PauseSessionAsync(PauseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PauseSessionRequest
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<PauseSessionResponse>
The call object.
PauseSessionAsync(PauseSessionRequest, CallOptions)
Pause a session by its id.
public virtual AsyncUnaryCall<PauseSessionResponse> PauseSessionAsync(PauseSessionRequest request, CallOptions options)
Parameters
request PauseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<PauseSessionResponse>
The call object.
PauseSessionAsync(PauseSessionRequest, Metadata, DateTime?, CancellationToken)
Pause a session by its id.
public virtual AsyncUnaryCall<PauseSessionResponse> PauseSessionAsync(PauseSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PauseSessionRequest
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<PauseSessionResponse>
The call object.
PauseSessionAsync(PauseSessionRequest, CallOptions)
Pause a session by its id.
public virtual AsyncUnaryCall<PauseSessionResponse> PauseSessionAsync(PauseSessionRequest request, CallOptions options)
Parameters
request PauseSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<PauseSessionResponse>
The call object.
PurgeSession(PurgeSessionRequest, Metadata, DateTime?, CancellationToken)
Purge a session by its id. Removes Results data.
public virtual PurgeSessionResponse PurgeSession(PurgeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PurgeSessionRequest
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.
PurgeSession(PurgeSessionRequest, CallOptions)
Purge a session by its id. Removes Results data.
public virtual PurgeSessionResponse PurgeSession(PurgeSessionRequest request, CallOptions options)
Parameters
request PurgeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
PurgeSession(PurgeSessionRequest, Metadata, DateTime?, CancellationToken)
Purge a session by its id. Removes Results data.
public virtual PurgeSessionResponse PurgeSession(PurgeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PurgeSessionRequest
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
PurgeSessionResponse
The response received from the server.
PurgeSession(PurgeSessionRequest, CallOptions)
Purge a session by its id. Removes Results data.
public virtual PurgeSessionResponse PurgeSession(PurgeSessionRequest request, CallOptions options)
Parameters
request PurgeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
PurgeSessionResponse
The response received from the server.
PurgeSessionAsync(PurgeSessionRequest, Metadata, DateTime?, CancellationToken)
Purge a session by its id. Removes Results data.
public virtual AsyncUnaryCall<PurgeSessionResponse> PurgeSessionAsync(PurgeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PurgeSessionRequest
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<PurgeSessionResponse>
The call object.
PurgeSessionAsync(PurgeSessionRequest, CallOptions)
Purge a session by its id. Removes Results data.
public virtual AsyncUnaryCall<PurgeSessionResponse> PurgeSessionAsync(PurgeSessionRequest request, CallOptions options)
Parameters
request PurgeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<PurgeSessionResponse>
The call object.
PurgeSessionAsync(PurgeSessionRequest, Metadata, DateTime?, CancellationToken)
Purge a session by its id. Removes Results data.
public virtual AsyncUnaryCall<PurgeSessionResponse> PurgeSessionAsync(PurgeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request PurgeSessionRequest
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<PurgeSessionResponse>
The call object.
PurgeSessionAsync(PurgeSessionRequest, CallOptions)
Purge a session by its id. Removes Results data.
public virtual AsyncUnaryCall<PurgeSessionResponse> PurgeSessionAsync(PurgeSessionRequest request, CallOptions options)
Parameters
request PurgeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<PurgeSessionResponse>
The call object.
ResumeSession(ResumeSessionRequest, Metadata, DateTime?, CancellationToken)
Resume a paused session by its id.
public virtual ResumeSessionResponse ResumeSession(ResumeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ResumeSessionRequest
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.
ResumeSession(ResumeSessionRequest, CallOptions)
Resume a paused session by its id.
public virtual ResumeSessionResponse ResumeSession(ResumeSessionRequest request, CallOptions options)
Parameters
request ResumeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
ResumeSession(ResumeSessionRequest, Metadata, DateTime?, CancellationToken)
Resume a paused session by its id.
public virtual ResumeSessionResponse ResumeSession(ResumeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ResumeSessionRequest
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
ResumeSessionResponse
The response received from the server.
ResumeSession(ResumeSessionRequest, CallOptions)
Resume a paused session by its id.
public virtual ResumeSessionResponse ResumeSession(ResumeSessionRequest request, CallOptions options)
Parameters
request ResumeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
ResumeSessionResponse
The response received from the server.
ResumeSessionAsync(ResumeSessionRequest, Metadata, DateTime?, CancellationToken)
Resume a paused session by its id.
public virtual AsyncUnaryCall<ResumeSessionResponse> ResumeSessionAsync(ResumeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ResumeSessionRequest
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<ResumeSessionResponse>
The call object.
ResumeSessionAsync(ResumeSessionRequest, CallOptions)
Resume a paused session by its id.
public virtual AsyncUnaryCall<ResumeSessionResponse> ResumeSessionAsync(ResumeSessionRequest request, CallOptions options)
Parameters
request ResumeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<ResumeSessionResponse>
The call object.
ResumeSessionAsync(ResumeSessionRequest, Metadata, DateTime?, CancellationToken)
Resume a paused session by its id.
public virtual AsyncUnaryCall<ResumeSessionResponse> ResumeSessionAsync(ResumeSessionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request ResumeSessionRequest
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<ResumeSessionResponse>
The call object.
ResumeSessionAsync(ResumeSessionRequest, CallOptions)
Resume a paused session by its id.
public virtual AsyncUnaryCall<ResumeSessionResponse> ResumeSessionAsync(ResumeSessionRequest request, CallOptions options)
Parameters
request ResumeSessionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<ResumeSessionResponse>
The call object.
StopSubmission(StopSubmissionRequest, Metadata, DateTime?, CancellationToken)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual StopSubmissionResponse StopSubmission(StopSubmissionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request StopSubmissionRequest
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.
StopSubmission(StopSubmissionRequest, CallOptions)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual StopSubmissionResponse StopSubmission(StopSubmissionRequest request, CallOptions options)
Parameters
request StopSubmissionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
The response received from the server.
StopSubmission(StopSubmissionRequest, Metadata, DateTime?, CancellationToken)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual StopSubmissionResponse StopSubmission(StopSubmissionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request StopSubmissionRequest
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
StopSubmissionResponse
The response received from the server.
StopSubmission(StopSubmissionRequest, CallOptions)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual StopSubmissionResponse StopSubmission(StopSubmissionRequest request, CallOptions options)
Parameters
request StopSubmissionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
StopSubmissionResponse
The response received from the server.
StopSubmissionAsync(StopSubmissionRequest, Metadata, DateTime?, CancellationToken)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual AsyncUnaryCall<StopSubmissionResponse> StopSubmissionAsync(StopSubmissionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request StopSubmissionRequest
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<StopSubmissionResponse>
The call object.
StopSubmissionAsync(StopSubmissionRequest, CallOptions)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual AsyncUnaryCall<StopSubmissionResponse> StopSubmissionAsync(StopSubmissionRequest request, CallOptions options)
Parameters
request StopSubmissionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<StopSubmissionResponse>
The call object.
StopSubmissionAsync(StopSubmissionRequest, Metadata, DateTime?, CancellationToken)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual AsyncUnaryCall<StopSubmissionResponse> StopSubmissionAsync(StopSubmissionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
request StopSubmissionRequest
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<StopSubmissionResponse>
The call object.
StopSubmissionAsync(StopSubmissionRequest, CallOptions)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual AsyncUnaryCall<StopSubmissionResponse> StopSubmissionAsync(StopSubmissionRequest request, CallOptions options)
Parameters
request StopSubmissionRequest
The request to send to the server.
options CallOptions
The options for the call.
Returns
AsyncUnaryCall<StopSubmissionResponse>
The call object.