JobRouterClient.GetJobsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetJobsAsync(Nullable<RouterJobStatusSelector>, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken) |
Retrieves list of jobs based on filter parameters. |
| GetJobsAsync(String, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, RequestContext) |
[Protocol Method] Retrieves list of jobs based on filter parameters.
|
GetJobsAsync(Nullable<RouterJobStatusSelector>, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)
- Source:
- JobRouterClient.cs
- Source:
- JobRouterClient.cs
Retrieves list of jobs based on filter parameters.
public virtual Azure.AsyncPageable<Azure.Communication.JobRouter.RouterJob> GetJobsAsync (Azure.Communication.JobRouter.RouterJobStatusSelector? status = default, string queueId = default, string channelId = default, string classificationPolicyId = default, DateTimeOffset? scheduledBefore = default, DateTimeOffset? scheduledAfter = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetJobsAsync : Nullable<Azure.Communication.JobRouter.RouterJobStatusSelector> * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.JobRouter.RouterJob>
override this.GetJobsAsync : Nullable<Azure.Communication.JobRouter.RouterJobStatusSelector> * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.JobRouter.RouterJob>Public Overridable Function GetJobsAsync (Optional status As Nullable(Of RouterJobStatusSelector) = Nothing, Optional queueId As String = Nothing, Optional channelId As String = Nothing, Optional classificationPolicyId As String = Nothing, Optional scheduledBefore As Nullable(Of DateTimeOffset) = Nothing, Optional scheduledAfter As Nullable(Of DateTimeOffset) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of RouterJob)Parameters
- status
- Nullable<RouterJobStatusSelector>
If specified, filter jobs by status.
- queueId
- String
If specified, filter jobs by queue.
- channelId
- String
If specified, filter jobs by channel.
- classificationPolicyId
- String
If specified, filter jobs by classificationPolicy.
- scheduledBefore
- Nullable<DateTimeOffset>
If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore].
- scheduledAfter
- Nullable<DateTimeOffset>
If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf).
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
GetJobsAsync(String, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, RequestContext)
- Source:
- JobRouterClient.cs
- Source:
- JobRouterClient.cs
[Protocol Method] Retrieves list of jobs based on filter parameters.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
- Please try the simpler Azure.Communication.JobRouter.JobRouterClient.GetJobsAsync(System.Nullable{System.Int32},System.Nullable{Azure.Communication.JobRouter.RouterJobStatusSelector},System.String,System.String,System.String,System.Nullable{System.DateTimeOffset},System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.AsyncPageable<BinaryData> GetJobsAsync (string status, string queueId, string channelId, string classificationPolicyId, DateTimeOffset? scheduledBefore, DateTimeOffset? scheduledAfter, Azure.RequestContext context);abstract member GetJobsAsync : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetJobsAsync : string * string * string * string * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>Public Overridable Function GetJobsAsync (status As String, queueId As String, channelId As String, classificationPolicyId As String, scheduledBefore As Nullable(Of DateTimeOffset), scheduledAfter As Nullable(Of DateTimeOffset), context As RequestContext) As AsyncPageable(Of BinaryData)Parameters
- status
- String
If specified, filter jobs by status. Allowed values: "all" | "pendingClassification" | "queued" | "assigned" | "completed" | "closed" | "cancelled" | "classificationFailed" | "created" | "pendingSchedule" | "scheduled" | "scheduleFailed" | "waitingForActivation" | "active".
- queueId
- String
If specified, filter jobs by queue.
- channelId
- String
If specified, filter jobs by channel.
- classificationPolicyId
- String
If specified, filter jobs by classificationPolicy.
- scheduledBefore
- Nullable<DateTimeOffset>
If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore].
- scheduledAfter
- Nullable<DateTimeOffset>
If specified, filter on jobs that was scheduled at or after given value. Range: [scheduledAfter, +Inf).
- context
- RequestContext
The request context, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The AsyncPageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.
Exceptions
Service returned a non-success status code.
Applies to
Azure SDK for .NET