JobRouterClient.GetQueueStatistics Method

Definition

Namespace:

Azure.Communication.JobRouter

Assembly:

Azure.Communication.JobRouter.dll

Package:

Azure.Communication.JobRouter v1.0.0

Overloads

GetQueueStatistics(String, RequestContext)	[Protocol Method] Retrieves a queue's statistics. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetQueueStatistics(String, CancellationToken) convenience overload with strongly typed models first.
GetQueueStatistics(String, CancellationToken)	Retrieves a queue's statistics.

GetQueueStatistics(String, RequestContext)

Source:

JobRouterClient.cs

[Protocol Method] Retrieves a queue's statistics.

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

public virtual Azure.Response GetQueueStatistics (string queueId, Azure.RequestContext context);

abstract member GetQueueStatistics : string * Azure.RequestContext -> Azure.Response
override this.GetQueueStatistics : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetQueueStatistics (queueId As String, context As RequestContext) As Response

Parameters

queueId

String

Id of the queue to retrieve statistics.

context

RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

queueId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetQueueStatistics(String, CancellationToken)

Source:

JobRouterClient.cs

Retrieves a queue's statistics.

public virtual Azure.Response<Azure.Communication.JobRouter.RouterQueueStatistics> GetQueueStatistics (string queueId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetQueueStatistics : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterQueueStatistics>
override this.GetQueueStatistics : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.JobRouter.RouterQueueStatistics>

Public Overridable Function GetQueueStatistics (queueId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RouterQueueStatistics)

Parameters

queueId

String

Id of the queue to retrieve statistics.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<RouterQueueStatistics>

Exceptions

ArgumentNullException

queueId is null.

ArgumentException

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