734 строки
98 KiB
YAML
734 строки
98 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.jobrouter.JobRouterAsyncClient"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient"
|
|
name: "JobRouterAsyncClient"
|
|
nameWithType: "JobRouterAsyncClient"
|
|
summary: "Initializes a new instance of the asynchronous Job<wbr>Router<wbr>Client type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **JobRouterAsyncClient**"
|
|
methods:
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.acceptJobOffer(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.acceptJobOffer(String workerId, String offerId)"
|
|
name: "acceptJobOffer(String workerId, String offerId)"
|
|
nameWithType: "JobRouterAsyncClient.acceptJobOffer(String workerId, String offerId)"
|
|
summary: "Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of an offer."
|
|
name: "offerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<AcceptJobOfferResult> acceptJobOffer(String workerId, String offerId)"
|
|
desc: "Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already."
|
|
returns:
|
|
description: "response containing ids for the worker, job, and assignment from an accepted offer on successful\n completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.AcceptJobOfferResult?alt=com.azure.communication.jobrouter.models.AcceptJobOfferResult&text=AcceptJobOfferResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.acceptJobOfferWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.acceptJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
name: "acceptJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.acceptJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
summary: "Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of an offer."
|
|
name: "offerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> acceptJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
desc: "Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already.\n\n**Response Body Schema**\n\n```java\n{\n assignmentId: String (Required)\n jobId: String (Required)\n workerId: String (Required)\n }\n```"
|
|
returns:
|
|
description: "response containing ids for the worker, job, and assignment from an accepted offer along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.cancelJob(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.cancelJob(String jobId, RequestOptions requestOptions)"
|
|
name: "cancelJob(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.cancelJob(String jobId, RequestOptions requestOptions)"
|
|
summary: "Submits request to cancel an existing job by Id while supplying free-form cancellation reason."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> cancelJob(String jobId, RequestOptions requestOptions)"
|
|
desc: "Submits request to cancel an existing job by Id while supplying free-form cancellation reason.\n\n**Request Body Schema**\n\n```java\n{\n note: String (Optional)\n dispositionCode: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "result object.\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.cancelJobWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.cancelJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
name: "cancelJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.cancelJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
summary: "Submits request to cancel an existing job by Id while supplying free-form cancellation reason."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> cancelJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
desc: "Submits request to cancel an existing job by Id while supplying free-form cancellation reason.\n\n**Request Body Schema**\n\n```java\n{\n note: String (Optional)\n dispositionCode: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "response payload from cancelling a job along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.closeJob(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.closeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
name: "closeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.closeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
summary: "Closes a completed job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> closeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
desc: "Closes a completed job.\n\n**Request Body Schema**\n\n```java\n{\n dispositionCode: String (Optional)\n closeAt: OffsetDateTime (Optional)\n note: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "Result."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.closeJobWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.closeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
name: "closeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.closeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
summary: "Closes a completed job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> closeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
desc: "Closes a completed job.\n\n**Request Body Schema**\n\n```java\n{\n dispositionCode: String (Optional)\n closeAt: OffsetDateTime (Optional)\n note: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "response payload from closing a job along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.completeJob(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.completeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
name: "completeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.completeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
summary: "Completes an assigned job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> completeJob(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
desc: "Completes an assigned job.\n\n**Request Body Schema**\n\n```java\n{\n note: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "result object.\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.completeJobWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.completeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
name: "completeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.completeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
summary: "Completes an assigned job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> completeJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
desc: "Completes an assigned job.\n\n**Request Body Schema**\n\n```java\n{\n note: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "response payload from completing a job along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.createJob(com.azure.communication.jobrouter.models.CreateJobOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.createJob(CreateJobOptions createJobOptions)"
|
|
name: "createJob(CreateJobOptions createJobOptions)"
|
|
nameWithType: "JobRouterAsyncClient.createJob(CreateJobOptions createJobOptions)"
|
|
summary: "Convenience method to create a job."
|
|
parameters:
|
|
- description: "Options to create RouterJob."
|
|
name: "createJobOptions"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<RouterJob> createJob(CreateJobOptions createJobOptions)"
|
|
desc: "Convenience method to create a job."
|
|
returns:
|
|
description: "resource The resource instance."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.createJobWithResponse(com.azure.communication.jobrouter.models.CreateJobOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.createJobWithResponse(CreateJobOptions createJobOptions)"
|
|
name: "createJobWithResponse(CreateJobOptions createJobOptions)"
|
|
nameWithType: "JobRouterAsyncClient.createJobWithResponse(CreateJobOptions createJobOptions)"
|
|
summary: "Create a job."
|
|
parameters:
|
|
- description: "Options to create RouterJob."
|
|
name: "createJobOptions"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<RouterJob>> createJobWithResponse(CreateJobOptions createJobOptions)"
|
|
desc: "Create a job."
|
|
returns:
|
|
description: "resource The resource instance."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.createWorker(com.azure.communication.jobrouter.models.CreateWorkerOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.createWorker(CreateWorkerOptions createWorkerOptions)"
|
|
name: "createWorker(CreateWorkerOptions createWorkerOptions)"
|
|
nameWithType: "JobRouterAsyncClient.createWorker(CreateWorkerOptions createWorkerOptions)"
|
|
summary: "Convenience method to create a worker."
|
|
parameters:
|
|
- description: "Container for inputs to create a worker."
|
|
name: "createWorkerOptions"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<RouterWorker> createWorker(CreateWorkerOptions createWorkerOptions)"
|
|
desc: "Convenience method to create a worker."
|
|
returns:
|
|
description: "an entity for jobs to be routed to."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.createWorkerWithResponse(com.azure.communication.jobrouter.models.CreateWorkerOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.createWorkerWithResponse(CreateWorkerOptions createWorkerOptions)"
|
|
name: "createWorkerWithResponse(CreateWorkerOptions createWorkerOptions)"
|
|
nameWithType: "JobRouterAsyncClient.createWorkerWithResponse(CreateWorkerOptions createWorkerOptions)"
|
|
summary: "Create a worker."
|
|
parameters:
|
|
- description: "Container for inputs to create a worker."
|
|
name: "createWorkerOptions"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<RouterWorker>> createWorkerWithResponse(CreateWorkerOptions createWorkerOptions)"
|
|
desc: "Create a worker."
|
|
returns:
|
|
description: "an entity for jobs to be routed to."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.declineJobOffer(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.declineJobOffer(String workerId, String offerId, RequestOptions requestOptions)"
|
|
name: "declineJobOffer(String workerId, String offerId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.declineJobOffer(String workerId, String offerId, RequestOptions requestOptions)"
|
|
summary: "Declines an offer to work on a job."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of an offer."
|
|
name: "offerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> declineJobOffer(String workerId, String offerId, RequestOptions requestOptions)"
|
|
desc: "Declines an offer to work on a job.\n\n**Request Body Schema**\n\n```java\n{\n retryOfferAt: OffsetDateTime (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "result object\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.declineJobOfferWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.declineJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
name: "declineJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.declineJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
summary: "Declines an offer to work on a job."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of an offer."
|
|
name: "offerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> declineJobOfferWithResponse(String workerId, String offerId, RequestOptions requestOptions)"
|
|
desc: "Declines an offer to work on a job.\n\n**Request Body Schema**\n\n```java\n{\n retryOfferAt: OffsetDateTime (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "response payload from declining a job along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteJob(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteJob(String jobId)"
|
|
name: "deleteJob(String jobId)"
|
|
nameWithType: "JobRouterAsyncClient.deleteJob(String jobId)"
|
|
summary: "Deletes a job and all of its traces."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<Void> deleteJob(String jobId)"
|
|
desc: "Deletes a job and all of its traces."
|
|
returns:
|
|
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteJobWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
name: "deleteJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.deleteJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
summary: "Deletes a job and all of its traces."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> deleteJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
desc: "Deletes a job and all of its traces."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteWorker(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteWorker(String workerId)"
|
|
name: "deleteWorker(String workerId)"
|
|
nameWithType: "JobRouterAsyncClient.deleteWorker(String workerId)"
|
|
summary: "Deletes a worker and all of its traces."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<Void> deleteWorker(String workerId)"
|
|
desc: "Deletes a worker and all of its traces."
|
|
returns:
|
|
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteWorkerWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.deleteWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
name: "deleteWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.deleteWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
summary: "Deletes a worker and all of its traces."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> deleteWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
desc: "Deletes a worker and all of its traces."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getJob(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getJob(String jobId)"
|
|
name: "getJob(String jobId)"
|
|
nameWithType: "JobRouterAsyncClient.getJob(String jobId)"
|
|
summary: "Retrieves an existing job by Id."
|
|
parameters:
|
|
- description: "The id of the job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<RouterJob> getJob(String jobId)"
|
|
desc: "Retrieves an existing job by Id."
|
|
returns:
|
|
description: "a unit of work to be routed on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getJobWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
name: "getJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.getJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
summary: "Retrieves an existing job by Id."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> getJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
desc: "Retrieves an existing job by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanOrEqual/greaterThan/greaterThanOrEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Required)\n }\n assignments (Optional): {\n String (Required): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Required)\n }\n notes (Optional): [\n (Optional){\n message: String (Required)\n addedAt: OffsetDateTime (Optional)\n }\n ]\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```"
|
|
returns:
|
|
description: "a unit of work to be routed along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueuePosition(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueuePosition(String jobId)"
|
|
name: "getQueuePosition(String jobId)"
|
|
nameWithType: "JobRouterAsyncClient.getQueuePosition(String jobId)"
|
|
summary: "Gets a job's position details."
|
|
parameters:
|
|
- description: "Id of the job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<RouterJobPositionDetails> getQueuePosition(String jobId)"
|
|
desc: "Gets a job's position details."
|
|
returns:
|
|
description: "a job's position details on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobPositionDetails?alt=com.azure.communication.jobrouter.models.RouterJobPositionDetails&text=RouterJobPositionDetails\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueuePositionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueuePositionWithResponse(String jobId, RequestOptions requestOptions)"
|
|
name: "getQueuePositionWithResponse(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.getQueuePositionWithResponse(String jobId, RequestOptions requestOptions)"
|
|
summary: "Gets a job's position details."
|
|
parameters:
|
|
- description: "Id of the job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> getQueuePositionWithResponse(String jobId, RequestOptions requestOptions)"
|
|
desc: "Gets a job's position details.\n\n**Response Body Schema**\n\n```java\n{\n jobId: String (Required)\n position: int (Required)\n queueId: String (Required)\n queueLength: int (Required)\n estimatedWaitTimeMinutes: double (Required)\n }\n```"
|
|
returns:
|
|
description: "a job's position details along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueueStatistics(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueueStatistics(String queueId)"
|
|
name: "getQueueStatistics(String queueId)"
|
|
nameWithType: "JobRouterAsyncClient.getQueueStatistics(String queueId)"
|
|
summary: "Retrieves a queue's statistics."
|
|
parameters:
|
|
- description: "Id of the queue to retrieve statistics."
|
|
name: "queueId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<RouterQueueStatistics> getQueueStatistics(String queueId)"
|
|
desc: "Retrieves a queue's statistics."
|
|
returns:
|
|
description: "statistics for the queue on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterQueueStatistics?alt=com.azure.communication.jobrouter.models.RouterQueueStatistics&text=RouterQueueStatistics\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueueStatisticsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getQueueStatisticsWithResponse(String queueId, RequestOptions requestOptions)"
|
|
name: "getQueueStatisticsWithResponse(String queueId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.getQueueStatisticsWithResponse(String queueId, RequestOptions requestOptions)"
|
|
summary: "Retrieves a queue's statistics."
|
|
parameters:
|
|
- description: "Id of the queue to retrieve statistics."
|
|
name: "queueId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> getQueueStatisticsWithResponse(String queueId, RequestOptions requestOptions)"
|
|
desc: "Retrieves a queue's statistics.\n\n**Response Body Schema**\n\n```java\n{\n queueId: String (Required)\n length: int (Required)\n estimatedWaitTimeMinutes (Optional): {\n String: double (Required)\n }\n longestJobWaitTimeMinutes: Double (Optional)\n }\n```"
|
|
returns:
|
|
description: "statistics for the queue along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getWorker(java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getWorker(String workerId)"
|
|
name: "getWorker(String workerId)"
|
|
nameWithType: "JobRouterAsyncClient.getWorker(String workerId)"
|
|
summary: "Retrieves an existing worker by Id."
|
|
parameters:
|
|
- description: "Id of the worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<RouterWorker> getWorker(String workerId)"
|
|
desc: "Retrieves an existing worker by Id."
|
|
returns:
|
|
description: "an entity for jobs to be routed to on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.getWorkerWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.getWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
name: "getWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.getWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
summary: "Retrieves an existing worker by Id."
|
|
parameters:
|
|
- description: "Id of a worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> getWorkerWithResponse(String workerId, RequestOptions requestOptions)"
|
|
desc: "Retrieves an existing worker by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queues (Optional): [\n String (Optional)\n ]\n capacity: Integer (Optional)\n labels (Optional): {\n String: Object (Required)\n }\n tags (Optional): {\n String: Object (Required)\n }\n channels (Optional): [\n (Optional){\n channelId: String (Required)\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n ]\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```"
|
|
returns:
|
|
description: "an entity for jobs to be routed to along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs()"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs()"
|
|
name: "listJobs()"
|
|
nameWithType: "JobRouterAsyncClient.listJobs()"
|
|
summary: "Retrieves list of jobs based on filter parameters."
|
|
syntax: "public PagedFlux<RouterJob> listJobs()"
|
|
desc: "Retrieves list of jobs based on filter parameters."
|
|
returns:
|
|
description: "a paged collection of jobs as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs(com.azure.communication.jobrouter.models.RouterJobStatusSelector,java.lang.String,java.lang.String,java.lang.String,java.time.OffsetDateTime,java.time.OffsetDateTime)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs(RouterJobStatusSelector status, String queueId, String channelId, String classificationPolicyId, OffsetDateTime scheduledBefore, OffsetDateTime scheduledAfter)"
|
|
name: "listJobs(RouterJobStatusSelector status, String queueId, String channelId, String classificationPolicyId, OffsetDateTime scheduledBefore, OffsetDateTime scheduledAfter)"
|
|
nameWithType: "JobRouterAsyncClient.listJobs(RouterJobStatusSelector status, String queueId, String channelId, String classificationPolicyId, OffsetDateTime scheduledBefore, OffsetDateTime scheduledAfter)"
|
|
summary: "Retrieves list of jobs based on filter parameters."
|
|
parameters:
|
|
- description: "If specified, filter jobs by status."
|
|
name: "status"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If specified, filter jobs by queue."
|
|
name: "queueId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "If specified, filter jobs by channel."
|
|
name: "channelId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "If specified, filter jobs by classificationPolicy."
|
|
name: "classificationPolicyId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "If specified, filter on jobs that was scheduled before or at given timestamp. Range:\n (-Inf, scheduledBefore]."
|
|
name: "scheduledBefore"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "If specified, filter on jobs that was scheduled at or after given value. Range:\n [scheduledAfter, +Inf)."
|
|
name: "scheduledAfter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public PagedFlux<RouterJob> listJobs(RouterJobStatusSelector status, String queueId, String channelId, String classificationPolicyId, OffsetDateTime scheduledBefore, OffsetDateTime scheduledAfter)"
|
|
desc: "Retrieves list of jobs based on filter parameters."
|
|
returns:
|
|
description: "a paged collection of jobs as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listJobs(RequestOptions requestOptions)"
|
|
name: "listJobs(RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.listJobs(RequestOptions requestOptions)"
|
|
summary: "Retrieves list of jobs based on filter parameters."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedFlux<BinaryData> listJobs(RequestOptions requestOptions)"
|
|
desc: "Retrieves list of jobs based on filter parameters.\n\n**Query Parameters**\n\n | ---------------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\n | status | String | No | If specified, filter jobs by status. Allowed values: \"all\", \"pendingClassification\", \"queued\", \"assigned\", \"completed\", \"closed\", \"cancelled\", \"classificationFailed\", \"created\", \"pendingSchedule\", \"scheduled\", \"scheduleFailed\", \"waitingForActivation\", \"active\". |\n | queueId | String | No | If specified, filter jobs by queue. |\n | channelId | String | No | If specified, filter jobs by channel. |\n | classificationPolicyId | String | No | If specified, filter jobs by classificationPolicy. |\n | scheduledBefore | OffsetDateTime | No | If specified, filter on jobs that was scheduled before or at given timestamp. Range: (-Inf, scheduledBefore\\]. |\n | scheduledAfter | OffsetDateTime | No | If specified, filter on jobs that was scheduled at or after given value. Range: \\[scheduledAfter, +Inf). |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanOrEqual/greaterThan/greaterThanOrEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Required)\n }\n assignments (Optional): {\n String (Required): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Required)\n }\n notes (Optional): [\n (Optional){\n message: String (Required)\n addedAt: OffsetDateTime (Optional)\n }\n ]\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```"
|
|
returns:
|
|
description: "paged collection of RouterJob items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers()"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers()"
|
|
name: "listWorkers()"
|
|
nameWithType: "JobRouterAsyncClient.listWorkers()"
|
|
summary: "Retrieves existing workers."
|
|
syntax: "public PagedFlux<RouterWorker> listWorkers()"
|
|
desc: "Retrieves existing workers."
|
|
returns:
|
|
description: "a paged collection of workers as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers(com.azure.communication.jobrouter.models.RouterWorkerStateSelector,java.lang.String,java.lang.String,java.lang.Boolean)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers(RouterWorkerStateSelector state, String channelId, String queueId, Boolean hasCapacity)"
|
|
name: "listWorkers(RouterWorkerStateSelector state, String channelId, String queueId, Boolean hasCapacity)"
|
|
nameWithType: "JobRouterAsyncClient.listWorkers(RouterWorkerStateSelector state, String channelId, String queueId, Boolean hasCapacity)"
|
|
summary: "Retrieves existing workers."
|
|
parameters:
|
|
- description: "If specified, select workers by worker state."
|
|
name: "state"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If specified, select workers who have a channel configuration with this channel."
|
|
name: "channelId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "If specified, select workers who are assigned to this queue."
|
|
name: "queueId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "If set to true, select only workers who have capacity for the channel specified by `channelId`\n or for any channel if `channelId` not specified. If set to false, then will return all workers including\n workers without any capacity for jobs. Defaults to false."
|
|
name: "hasCapacity"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public PagedFlux<RouterWorker> listWorkers(RouterWorkerStateSelector state, String channelId, String queueId, Boolean hasCapacity)"
|
|
desc: "Retrieves existing workers."
|
|
returns:
|
|
description: "a paged collection of workers as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.listWorkers(RequestOptions requestOptions)"
|
|
name: "listWorkers(RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.listWorkers(RequestOptions requestOptions)"
|
|
summary: "Retrieves existing workers."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedFlux<BinaryData> listWorkers(RequestOptions requestOptions)"
|
|
desc: "Retrieves existing workers.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\n | state | String | No | If specified, select workers by worker state. Allowed values: \"active\", \"draining\", \"inactive\", \"all\". |\n | channelId | String | No | If specified, select workers who have a channel configuration with this channel. |\n | queueId | String | No | If specified, select workers who are assigned to this queue. |\n | hasCapacity | Boolean | No | If set to true, select only workers who have capacity for the channel specified by \\`channelId\\` or for any channel if \\`channelId\\` not specified. If set to false, then will return all workers including workers without any capacity for jobs. Defaults to false. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queues (Optional): [\n String (Optional)\n ]\n capacity: Integer (Optional)\n labels (Optional): {\n String: Object (Required)\n }\n tags (Optional): {\n String: Object (Required)\n }\n channels (Optional): [\n (Optional){\n channelId: String (Required)\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n ]\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```"
|
|
returns:
|
|
description: "paged collection of RouterWorker items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.reclassifyJob(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.reclassifyJob(String jobId, RequestOptions requestOptions)"
|
|
name: "reclassifyJob(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.reclassifyJob(String jobId, RequestOptions requestOptions)"
|
|
summary: "Reclassify a job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> reclassifyJob(String jobId, RequestOptions requestOptions)"
|
|
desc: "Reclassify a job.\n\n**Request Body Schema**\n\n```java\n{\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "result object.\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.reclassifyJobWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.reclassifyJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
name: "reclassifyJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.reclassifyJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
summary: "Reclassify a job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> reclassifyJobWithResponse(String jobId, RequestOptions requestOptions)"
|
|
desc: "Reclassify a job.\n\n**Request Body Schema**\n\n```java\n{\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n }\n```"
|
|
returns:
|
|
description: "response payload from reclassifying a job along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJob(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJob(String jobId, String assignmentId)"
|
|
name: "unassignJob(String jobId, String assignmentId)"
|
|
nameWithType: "JobRouterAsyncClient.unassignJob(String jobId, String assignmentId)"
|
|
summary: "Unassign a job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<UnassignJobResult> unassignJob(String jobId, String assignmentId)"
|
|
desc: "Unassign a job."
|
|
returns:
|
|
description: "response payload after a job has been successfully unassigned on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.UnassignJobResult?alt=com.azure.communication.jobrouter.models.UnassignJobResult&text=UnassignJobResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJob(java.lang.String,java.lang.String,com.azure.communication.jobrouter.models.UnassignJobOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJob(String jobId, String assignmentId, UnassignJobOptions options)"
|
|
name: "unassignJob(String jobId, String assignmentId, UnassignJobOptions options)"
|
|
nameWithType: "JobRouterAsyncClient.unassignJob(String jobId, String assignmentId, UnassignJobOptions options)"
|
|
summary: "Unassign a job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Request body for unassign route."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.communication.jobrouter.models.UnassignJobOptions?alt=com.azure.communication.jobrouter.models.UnassignJobOptions&text=UnassignJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<UnassignJobResult> unassignJob(String jobId, String assignmentId, UnassignJobOptions options)"
|
|
desc: "Unassign a job."
|
|
returns:
|
|
description: "response payload after a job has been successfully unassigned on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.UnassignJobResult?alt=com.azure.communication.jobrouter.models.UnassignJobResult&text=UnassignJobResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJobWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.unassignJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
name: "unassignJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.unassignJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
summary: "Unassign a job."
|
|
parameters:
|
|
- description: "Id of a job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Id of a job assignment."
|
|
name: "assignmentId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> unassignJobWithResponse(String jobId, String assignmentId, RequestOptions requestOptions)"
|
|
desc: "Unassign a job.\n\n**Request Body Schema**\n\n```java\n{\n suspendMatching: Boolean (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n jobId: String (Required)\n unassignmentCount: int (Required)\n }\n```"
|
|
returns:
|
|
description: "response payload after a job has been successfully unassigned along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful\n completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateJob(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateJob(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
name: "updateJob(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.updateJob(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
summary: "Updates a router job."
|
|
parameters:
|
|
- description: "The jobId of the job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The resource instance."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> updateJob(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
desc: "Updates a router job.\n\n**Header Parameters**\n\n | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | If-Match | String | No | The request should only proceed if an entity matches this string. |\n | If-Unmodified-Since | OffsetDateTime | No | The request should only proceed if the entity was not modified after this time. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addHeader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addHeader\"></xref>\n\n**Request Body Schema**\n\n```java\n{\n jobId: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanEqual/greaterThan/greaterThanEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Optional)\n }\n assignments (Optional): {\n String (Optional): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Optional)\n }\n notes (Optional): {\n String: String (Optional)\n }\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n jobId: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanEqual/greaterThan/greaterThanEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Optional)\n }\n assignments (Optional): {\n String (Optional): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Optional)\n }\n notes (Optional): {\n String: String (Optional)\n }\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```"
|
|
returns:
|
|
description: "result object."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateJobWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateJobWithResponse(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
name: "updateJobWithResponse(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.updateJobWithResponse(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
summary: "Updates a router job."
|
|
parameters:
|
|
- description: "The jobId of the job."
|
|
name: "jobId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The resource instance."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> updateJobWithResponse(String jobId, BinaryData resource, RequestOptions requestOptions)"
|
|
desc: "Updates a router job.\n\n**Header Parameters**\n\n | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | If-Match | String | No | The request should only proceed if an entity matches this string. |\n | If-Unmodified-Since | OffsetDateTime | No | The request should only proceed if the entity was not modified after this time. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addHeader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addHeader\"></xref>\n\n**Request Body Schema**\n\n```java\n{\n jobId: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanEqual/greaterThan/greaterThanEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Optional)\n }\n assignments (Optional): {\n String (Optional): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Optional)\n }\n notes (Optional): {\n String: String (Optional)\n }\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n jobId: String (Required)\n channelReference: String (Optional)\n status: String(pendingClassification/queued/assigned/completed/closed/cancelled/classificationFailed/created/pendingSchedule/scheduled/scheduleFailed/waitingForActivation) (Optional)\n enqueuedAt: OffsetDateTime (Optional)\n channelId: String (Optional)\n classificationPolicyId: String (Optional)\n queueId: String (Optional)\n priority: Integer (Optional)\n dispositionCode: String (Optional)\n requestedWorkerSelectors (Optional): [\n (Optional){\n key: String (Required)\n labelOperator: String(equal/notEqual/lessThan/lessThanEqual/greaterThan/greaterThanEqual) (Required)\n value: Object (Optional)\n expiresAfterSeconds: Double (Optional)\n expedite: Boolean (Optional)\n status: String(active/expired) (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n attachedWorkerSelectors (Optional): [\n (recursive schema, see above)\n ]\n labels (Optional): {\n String: Object (Optional)\n }\n assignments (Optional): {\n String (Optional): {\n assignmentId: String (Required)\n workerId: String (Optional)\n assignedAt: OffsetDateTime (Required)\n completedAt: OffsetDateTime (Optional)\n closedAt: OffsetDateTime (Optional)\n }\n }\n tags (Optional): {\n String: Object (Optional)\n }\n notes (Optional): {\n String: String (Optional)\n }\n scheduledAt: OffsetDateTime (Optional)\n matchingMode (Optional): {\n }\n }\n```"
|
|
returns:
|
|
description: "a unit of work to be routed along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateWorker(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateWorker(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
name: "updateWorker(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.updateWorker(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
summary: "Updates a worker."
|
|
parameters:
|
|
- description: "Id of the worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The resource instance."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<BinaryData> updateWorker(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
desc: "Updates a worker.\n\n**Header Parameters**\n\n | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | If-Match | String | No | The request should only proceed if an entity matches this string. |\n | If-Unmodified-Since | OffsetDateTime | No | The request should only proceed if the entity was not modified after this time. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addHeader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addHeader\"></xref>\n\n**Request Body Schema**\n\n```java\n{\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queueAssignments (Optional): {\n String (Optional): {\n }\n }\n totalCapacity: Integer (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n tags (Optional): {\n String: Object (Optional)\n }\n channelConfigurations (Optional): {\n String (Optional): {\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n }\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queueAssignments (Optional): {\n String (Optional): {\n }\n }\n totalCapacity: Integer (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n tags (Optional): {\n String: Object (Optional)\n }\n channelConfigurations (Optional): {\n String (Optional): {\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n }\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```"
|
|
returns:
|
|
description: "result object."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateWorkerWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.jobrouter.JobRouterAsyncClient.updateWorkerWithResponse(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
name: "updateWorkerWithResponse(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
nameWithType: "JobRouterAsyncClient.updateWorkerWithResponse(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
summary: "Updates a worker."
|
|
parameters:
|
|
- description: "Id of the worker."
|
|
name: "workerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The resource instance."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<BinaryData>> updateWorkerWithResponse(String workerId, BinaryData resource, RequestOptions requestOptions)"
|
|
desc: "Updates a worker.\n\n**Header Parameters**\n\n | ------------------- | -------------- | -------- | ------------------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | If-Match | String | No | The request should only proceed if an entity matches this string. |\n | If-Unmodified-Since | OffsetDateTime | No | The request should only proceed if the entity was not modified after this time. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addHeader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addHeader\"></xref>\n\n**Request Body Schema**\n\n```java\n{\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queueAssignments (Optional): {\n String (Optional): {\n }\n }\n totalCapacity: Integer (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n tags (Optional): {\n String: Object (Optional)\n }\n channelConfigurations (Optional): {\n String (Optional): {\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n }\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n id: String (Required)\n state: String(active/draining/inactive) (Optional)\n queueAssignments (Optional): {\n String (Optional): {\n }\n }\n totalCapacity: Integer (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n tags (Optional): {\n String: Object (Optional)\n }\n channelConfigurations (Optional): {\n String (Optional): {\n capacityCostPerJob: int (Required)\n maxNumberOfJobs: Integer (Optional)\n }\n }\n offers (Optional): [\n (Optional){\n offerId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n offeredAt: OffsetDateTime (Optional)\n expiresAt: OffsetDateTime (Optional)\n }\n ]\n assignedJobs (Optional): [\n (Optional){\n assignmentId: String (Required)\n jobId: String (Required)\n capacityCost: int (Required)\n assignedAt: OffsetDateTime (Required)\n }\n ]\n loadRatio: Double (Optional)\n availableForOffers: Boolean (Optional)\n }\n```"
|
|
returns:
|
|
description: "an entity for jobs to be routed to along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the asynchronous JobRouterClient type."
|
|
metadata: {}
|
|
package: "com.azure.communication.jobrouter"
|
|
artifact: com.azure:azure-communication-jobrouter:1.1.9
|