JobRouterClient.GetWorkerAsync Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

GetWorkerAsync(String, CancellationToken)	Retrieves an existing worker by Id.
GetWorkerAsync(String, RequestContext)	[Protocol Method] Retrieves an existing worker by Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetWorkerAsync(String, CancellationToken) convenience overload with strongly typed models first.

GetWorkerAsync(String, CancellationToken)

Source:

JobRouterClient.cs

Retrieves an existing worker by Id.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterWorker>> GetWorkerAsync (string workerId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetWorkerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterWorker>>
override this.GetWorkerAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.JobRouter.RouterWorker>>

Public Overridable Function GetWorkerAsync (workerId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RouterWorker))

Parameters

workerId

String

Id of a worker.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<RouterWorker>>

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

workerId is null.

ArgumentException

workerId is an empty string, and was expected to be non-empty.

GetWorkerAsync(String, RequestContext)

Source:

JobRouterClient.cs

[Protocol Method] Retrieves an existing worker by Id.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetWorkerAsync(String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetWorkerAsync (string workerId, Azure.RequestContext context);

abstract member GetWorkerAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetWorkerAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetWorkerAsync (workerId As String, context As RequestContext) As Task(Of Response)

Parameters

workerId

String

Id of a worker.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

workerId is null.

ArgumentException

workerId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.