JobRouterClient Class
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.
The JobRouter service client.
public class JobRouterClienttype JobRouterClient = classPublic Class JobRouterClient- Inheritance
-
JobRouterClient
Constructors
| JobRouterClient() |
Initializes a new instance of JobRouterClient for mocking. |
| JobRouterClient(String, JobRouterClientOptions) |
Initializes a new instance of JobRouterClient. |
| JobRouterClient(Uri, AzureKeyCredential, JobRouterClientOptions) |
Initializes a new instance of JobRouterClient. |
| JobRouterClient(Uri, TokenCredential, JobRouterClientOptions) |
Initializes a new instance of JobRouterClient. |
Properties
| Pipeline |
The HTTP pipeline for sending and receiving REST requests and responses. |
Methods
| AcceptJobOffer(String, String, CancellationToken) |
Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. |
| AcceptJobOffer(String, String, RequestContext) |
[Protocol Method] Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.
|
| AcceptJobOfferAsync(String, String, CancellationToken) |
Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. |
| AcceptJobOfferAsync(String, String, RequestContext) |
[Protocol Method] Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.
|
| CancelJob(CancelJobOptions, CancellationToken) |
Submits request to cancel an existing job by Id while supplying free-form cancellation reason. |
| CancelJob(String, RequestContent, RequestContext) |
[Protocol Method] Submits request to cancel an existing job by Id while supplying free-form cancellation reason.
|
| CancelJobAsync(CancelJobOptions, CancellationToken) |
Submits request to cancel an existing job by Id while supplying free-form cancellation reason. |
| CancelJobAsync(String, RequestContent, RequestContext) |
[Protocol Method] Submits request to cancel an existing job by Id while supplying free-form cancellation reason.
|
| CloseJob(CloseJobOptions, CancellationToken) |
Closes a completed job. |
| CloseJob(String, String, RequestContent, RequestContext) |
[Protocol Method] Closes a completed job.
|
| CloseJobAsync(CloseJobOptions, CancellationToken) |
Closes a completed job. |
| CloseJobAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Closes a completed job.
|
| CompleteJob(CompleteJobOptions, CancellationToken) |
Completes an assigned job. |
| CompleteJob(String, String, RequestContent, RequestContext) |
[Protocol Method] Completes an assigned job.
|
| CompleteJobAsync(CompleteJobOptions, CancellationToken) |
Completes an assigned job. |
| CompleteJobAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Completes an assigned job.
|
| CreateJob(CreateJobOptions, CancellationToken) |
Creates a new job to be routed. |
| CreateJobAsync(CreateJobOptions, CancellationToken) |
Creates a new job to be routed. |
| CreateJobWithClassificationPolicy(CreateJobWithClassificationPolicyOptions, CancellationToken) |
Creates a new job to be routed with classification property. |
| CreateJobWithClassificationPolicyAsync(CreateJobWithClassificationPolicyOptions, CancellationToken) |
Creates a new job to be routed with classification property. |
| CreateWorker(CreateWorkerOptions, CancellationToken) |
Create or update a worker to process jobs. |
| CreateWorkerAsync(CreateWorkerOptions, CancellationToken) |
Create or update a worker to process jobs. |
| DeclineJobOffer(DeclineJobOfferOptions, CancellationToken) |
Declines an offer to work on a job. |
| DeclineJobOffer(String, String, RequestContent, RequestContext) |
[Protocol Method] Declines an offer to work on a job.
|
| DeclineJobOfferAsync(DeclineJobOfferOptions, CancellationToken) |
Declines an offer to work on a job. |
| DeclineJobOfferAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Declines an offer to work on a job.
|
| DeleteJob(String, RequestContext) |
[Protocol Method] Deletes a job and all of its traces.
|
| DeleteJobAsync(String, RequestContext) |
[Protocol Method] Deletes a job and all of its traces.
|
| DeleteWorker(String, RequestContext) |
[Protocol Method] Deletes a worker and all of its traces.
|
| DeleteWorkerAsync(String, RequestContext) |
[Protocol Method] Deletes a worker and all of its traces.
|
| GetJob(String, CancellationToken) |
Retrieves an existing job by Id. |
| GetJob(String, RequestContext) |
[Protocol Method] Retrieves an existing job by Id.
|
| GetJobAsync(String, CancellationToken) |
Retrieves an existing job by Id. |
| GetJobAsync(String, RequestContext) |
[Protocol Method] Retrieves an existing job by Id.
|
| GetJobs(Nullable<RouterJobStatusSelector>, String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken) |
Retrieves list of jobs based on filter parameters. |
| GetJobs(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) |
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.
|
| GetQueuePosition(String, CancellationToken) |
Gets a job's position details. |
| GetQueuePosition(String, RequestContext) |
[Protocol Method] Gets a job's position details.
|
| GetQueuePositionAsync(String, CancellationToken) |
Gets a job's position details. |
| GetQueuePositionAsync(String, RequestContext) |
[Protocol Method] Gets a job's position details.
|
| GetQueueStatistics(String, CancellationToken) |
Retrieves a queue's statistics. |
| GetQueueStatistics(String, RequestContext) |
[Protocol Method] Retrieves a queue's statistics.
|
| GetQueueStatisticsAsync(String, CancellationToken) |
Retrieves a queue's statistics. |
| GetQueueStatisticsAsync(String, RequestContext) |
[Protocol Method] Retrieves a queue's statistics.
|
| GetWorker(String, CancellationToken) |
Retrieves an existing worker by Id. |
| GetWorker(String, RequestContext) |
[Protocol Method] Retrieves an existing worker by Id.
|
| GetWorkerAsync(String, CancellationToken) |
Retrieves an existing worker by Id. |
| GetWorkerAsync(String, RequestContext) |
[Protocol Method] Retrieves an existing worker by Id.
|
| GetWorkers(Nullable<RouterWorkerStateSelector>, String, String, Nullable<Boolean>, CancellationToken) |
Retrieves existing workers. |
| GetWorkers(String, String, String, Nullable<Boolean>, RequestContext) |
[Protocol Method] Retrieves existing workers.
|
| GetWorkersAsync(Nullable<RouterWorkerStateSelector>, String, String, Nullable<Boolean>, CancellationToken) |
Retrieves existing workers. |
| GetWorkersAsync(String, String, String, Nullable<Boolean>, RequestContext) |
[Protocol Method] Retrieves existing workers.
|
| ReclassifyJob(String, CancellationToken) |
Reclassify a job. |
| ReclassifyJob(String, RequestContent, RequestContext) |
[Protocol Method] Reclassify a job.
|
| ReclassifyJobAsync(String, CancellationToken) |
Reclassify a job. |
| ReclassifyJobAsync(String, RequestContent, RequestContext) |
[Protocol Method] Reclassify a job.
|
| UnassignJob(String, String, RequestContent, RequestContext) |
[Protocol Method] Unassign a job.
|
| UnassignJob(UnassignJobOptions, CancellationToken) |
Unassign a job. |
| UnassignJobAsync(String, String, RequestContent, RequestContext) |
[Protocol Method] Unassign a job.
|
| UnassignJobAsync(UnassignJobOptions, CancellationToken) |
Unassign a job. |
| UpdateJob(RouterJob, RequestConditions, CancellationToken) |
Update an existing job. |
| UpdateJob(String, RequestContent, RequestConditions, RequestContext) |
[Protocol Method] Updates a router job.
|
| UpdateJobAsync(RouterJob, RequestConditions, CancellationToken) |
Update an existing job. |
| UpdateJobAsync(String, RequestContent, RequestConditions, RequestContext) |
[Protocol Method] Updates a router job.
|
| UpdateWorker(RouterWorker, RequestConditions, CancellationToken) |
Update a worker to process jobs. |
| UpdateWorker(String, RequestContent, RequestConditions, RequestContext) |
[Protocol Method] Updates a worker.
|
| UpdateWorkerAsync(RouterWorker, RequestConditions, CancellationToken) |
Update a worker to process jobs. |
| UpdateWorkerAsync(String, RequestContent, RequestConditions, RequestContext) |
[Protocol Method] Updates a worker.
|
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for