CI Update
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=401236&view=results
This commit is contained in:
VSC-Service-Account
Родитель
64acefd121
Коммит
b4c426ebb8
|
|
@ -0,0 +1,645 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient"
|
||||
name: "JobRouterAdministrationAsyncClient"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient"
|
||||
summary: "Initializes a new instance of the asynchronous Job<wbr>Router<wbr>Administration<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 **JobRouterAdministrationAsyncClient**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createClassificationPolicy(com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
name: "createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
summary: "Convenience method to create a classification policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a classification policy."
|
||||
name: "createClassificationPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<ClassificationPolicy> createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
desc: "Convenience method to create a classification policy."
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified."
|
||||
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createClassificationPolicyWithResponse(com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
name: "createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
summary: "Creates a classification policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a classification policy."
|
||||
name: "createClassificationPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<ClassificationPolicy>> createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
desc: "Creates a classification policy."
|
||||
returns:
|
||||
description: "response The response 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.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createDistributionPolicy(com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
name: "createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
summary: "Creates a distribution policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a distribution policy."
|
||||
name: "createDistributionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions&text=CreateDistributionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<DistributionPolicy> createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
desc: "Creates a distribution policy."
|
||||
returns:
|
||||
description: "response The response 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.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createDistributionPolicyWithResponse(com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
name: "createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
summary: "Creates a distribution policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a distribution policy."
|
||||
name: "createDistributionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions&text=CreateDistributionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<DistributionPolicy>> createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
desc: "Creates a distribution policy."
|
||||
returns:
|
||||
description: "response The response 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.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createExceptionPolicy(com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
name: "createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
summary: "Creates an exception policy."
|
||||
parameters:
|
||||
- description: "Create options for Exception Policy."
|
||||
name: "createExceptionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions&text=CreateExceptionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<ExceptionPolicy> createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
desc: "Creates an exception policy."
|
||||
returns:
|
||||
description: "response The response 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.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createExceptionPolicyWithResponse(com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
name: "createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
summary: "Creates an exception policy."
|
||||
parameters:
|
||||
- description: "Create options for Exception Policy."
|
||||
name: "createExceptionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions&text=CreateExceptionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<ExceptionPolicy>> createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
desc: "Creates an exception policy."
|
||||
returns:
|
||||
description: "response The response 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.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createQueue(com.azure.communication.jobrouter.models.CreateQueueOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createQueue(CreateQueueOptions createQueueOptions)"
|
||||
name: "createQueue(CreateQueueOptions createQueueOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createQueue(CreateQueueOptions createQueueOptions)"
|
||||
summary: "Create a queue."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a queue."
|
||||
name: "createQueueOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<RouterQueue> createQueue(CreateQueueOptions createQueueOptions)"
|
||||
desc: "Create a queue."
|
||||
returns:
|
||||
description: "response The response 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.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createQueueWithResponse(com.azure.communication.jobrouter.models.CreateQueueOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.createQueueWithResponse(CreateQueueOptions createQueueOptions)"
|
||||
name: "createQueueWithResponse(CreateQueueOptions createQueueOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.createQueueWithResponse(CreateQueueOptions createQueueOptions)"
|
||||
summary: "Create a queue."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a queue."
|
||||
name: "createQueueOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public Mono<Response<RouterQueue>> createQueueWithResponse(CreateQueueOptions createQueueOptions)"
|
||||
desc: "Create a queue."
|
||||
returns:
|
||||
description: "response The response 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.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteClassificationPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteClassificationPolicy(String classificationPolicyId)"
|
||||
name: "deleteClassificationPolicy(String classificationPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteClassificationPolicy(String classificationPolicyId)"
|
||||
summary: "Delete a classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteClassificationPolicy(String classificationPolicyId)"
|
||||
desc: "Delete a classification policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteClassificationPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Delete a classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
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>> deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Delete a classification policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteDistributionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteDistributionPolicy(String distributionPolicyId)"
|
||||
name: "deleteDistributionPolicy(String distributionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteDistributionPolicy(String distributionPolicyId)"
|
||||
summary: "Delete a distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteDistributionPolicy(String distributionPolicyId)"
|
||||
desc: "Delete a distribution policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteDistributionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Delete a distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
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>> deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Delete a distribution policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteExceptionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
name: "deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
summary: "Deletes a exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
desc: "Deletes a exception policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteExceptionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Deletes a exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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>> deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Deletes a exception policy by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteQueue(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteQueue(String queueId)"
|
||||
name: "deleteQueue(String queueId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteQueue(String queueId)"
|
||||
summary: "Deletes a queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<Void> deleteQueue(String queueId)"
|
||||
desc: "Deletes a queue by Id."
|
||||
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.JobRouterAdministrationAsyncClient.deleteQueueWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
name: "deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
summary: "Deletes a queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
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<Void>> deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
desc: "Deletes a queue by Id."
|
||||
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.JobRouterAdministrationAsyncClient.getClassificationPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getClassificationPolicy(String classificationPolicyId)"
|
||||
name: "getClassificationPolicy(String classificationPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getClassificationPolicy(String classificationPolicyId)"
|
||||
summary: "Retrieves an existing classification policy by Id."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<ClassificationPolicy> getClassificationPolicy(String classificationPolicyId)"
|
||||
desc: "Retrieves an existing classification policy by Id."
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified 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.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getClassificationPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
name: "getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
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>> getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing classification policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified 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.JobRouterAdministrationAsyncClient.getDistributionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getDistributionPolicy(String distributionPolicyId)"
|
||||
name: "getDistributionPolicy(String distributionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getDistributionPolicy(String distributionPolicyId)"
|
||||
summary: "Retrieves an existing distribution policy by Id."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<DistributionPolicy> getDistributionPolicy(String distributionPolicyId)"
|
||||
desc: "Retrieves an existing distribution policy by Id."
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers 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.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getDistributionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
name: "getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
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>> getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing distribution policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion\n 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.JobRouterAdministrationAsyncClient.getExceptionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getExceptionPolicy(String exceptionPolicyId)"
|
||||
name: "getExceptionPolicy(String exceptionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getExceptionPolicy(String exceptionPolicyId)"
|
||||
summary: "Retrieves an existing exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<ExceptionPolicy> getExceptionPolicy(String exceptionPolicyId)"
|
||||
desc: "Retrieves an existing exception policy by Id."
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered 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.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getExceptionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
name: "getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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>> getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing exception policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n exceptionRules (Optional): [\n (Optional){\n id: String (Required)\n trigger (Required): {\n }\n actions (Required): [\n (Required){\n id: String (Optional)\n }\n ]\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on\n 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.JobRouterAdministrationAsyncClient.getQueue(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getQueue(String queueId)"
|
||||
name: "getQueue(String queueId)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getQueue(String queueId)"
|
||||
summary: "Retrieves an existing queue by Id."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public Mono<RouterQueue> getQueue(String queueId)"
|
||||
desc: "Retrieves an existing queue by Id."
|
||||
returns:
|
||||
description: "a queue that can contain jobs 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.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getQueueWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
name: "getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
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>> getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing queue by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "a queue that can contain jobs 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\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.JobRouterAdministrationAsyncClient.listClassificationPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listClassificationPolicies()"
|
||||
name: "listClassificationPolicies()"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listClassificationPolicies()"
|
||||
summary: "Retrieves existing classification policies."
|
||||
syntax: "public PagedFlux<ClassificationPolicy> listClassificationPolicies()"
|
||||
desc: "Retrieves existing classification policies."
|
||||
returns:
|
||||
description: "a paged collection of classification policies 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.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listClassificationPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listClassificationPolicies(RequestOptions requestOptions)"
|
||||
name: "listClassificationPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listClassificationPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing classification policies."
|
||||
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> listClassificationPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing classification policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of ClassificationPolicy 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.JobRouterAdministrationAsyncClient.listDistributionPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listDistributionPolicies()"
|
||||
name: "listDistributionPolicies()"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listDistributionPolicies()"
|
||||
summary: "Retrieves existing distribution policies."
|
||||
syntax: "public PagedFlux<DistributionPolicy> listDistributionPolicies()"
|
||||
desc: "Retrieves existing distribution policies."
|
||||
returns:
|
||||
description: "a paged collection of distribution policies 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.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listDistributionPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listDistributionPolicies(RequestOptions requestOptions)"
|
||||
name: "listDistributionPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listDistributionPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing distribution policies."
|
||||
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> listDistributionPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing distribution policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of DistributionPolicy 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.JobRouterAdministrationAsyncClient.listExceptionPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listExceptionPolicies()"
|
||||
name: "listExceptionPolicies()"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listExceptionPolicies()"
|
||||
summary: "Retrieves existing exception policies."
|
||||
syntax: "public PagedFlux<ExceptionPolicy> listExceptionPolicies()"
|
||||
desc: "Retrieves existing exception policies."
|
||||
returns:
|
||||
description: "paged collection of ExceptionPolicy 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.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listExceptionPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listExceptionPolicies(RequestOptions requestOptions)"
|
||||
name: "listExceptionPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listExceptionPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing exception policies."
|
||||
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> listExceptionPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing exception policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n exceptionRules (Optional): [\n (Optional){\n id: String (Required)\n trigger (Required): {\n }\n actions (Required): [\n (Required){\n id: String (Optional)\n }\n ]\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of ExceptionPolicy 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.JobRouterAdministrationAsyncClient.listQueues()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listQueues()"
|
||||
name: "listQueues()"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listQueues()"
|
||||
summary: "Retrieves existing queues."
|
||||
syntax: "public PagedFlux<RouterQueue> listQueues()"
|
||||
desc: "Retrieves existing queues."
|
||||
returns:
|
||||
description: "a paged collection of queues 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.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listQueues(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.listQueues(RequestOptions requestOptions)"
|
||||
name: "listQueues(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.listQueues(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing queues."
|
||||
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> listQueues(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing queues.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of RouterQueue 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.JobRouterAdministrationAsyncClient.updateClassificationPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a classification policy."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
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> updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a classification policy.\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 classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "result object.\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.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateClassificationPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a classification policy."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
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>> updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a classification policy.\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 classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified 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.JobRouterAdministrationAsyncClient.updateDistributionPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a distribution policy."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
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> updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a distribution policy.\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 distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion\n 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.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateDistributionPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a distribution policy."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
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>> updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a distribution policy.\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 distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion\n 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.JobRouterAdministrationAsyncClient.updateExceptionPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a exception policy."
|
||||
parameters:
|
||||
- description: "The Id of the exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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> updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a exception policy.\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 exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```"
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on\n 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.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateExceptionPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a exception policy."
|
||||
parameters:
|
||||
- description: "The Id of the exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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>> updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a exception policy.\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 exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```"
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on\n 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.JobRouterAdministrationAsyncClient.updateQueue(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a queue."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
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> updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a queue.\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 queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "result object.\n Mono}."
|
||||
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.JobRouterAdministrationAsyncClient.updateQueueWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient.updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationAsyncClient.updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a queue."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
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>> updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a queue.\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 queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "a queue that can contain jobs 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\" />>>"
|
||||
type: "class"
|
||||
desc: "Initializes a new instance of the asynchronous JobRouterAdministrationClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,645 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient"
|
||||
name: "JobRouterAdministrationClient"
|
||||
nameWithType: "JobRouterAdministrationClient"
|
||||
summary: "Initializes a new instance of the synchronous Job<wbr>Router<wbr>Administration<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 **JobRouterAdministrationClient**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createClassificationPolicy(com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
name: "createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
summary: "Convenience method to create a classification policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a classification policy."
|
||||
name: "createClassificationPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ClassificationPolicy createClassificationPolicy(CreateClassificationPolicyOptions createClassificationPolicyOptions)"
|
||||
desc: "Convenience method to create a classification policy."
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createClassificationPolicyWithResponse(com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions, RequestOptions requestOptions)"
|
||||
name: "createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions, RequestOptions requestOptions)"
|
||||
summary: "Create a classification policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a classification policy."
|
||||
name: "createClassificationPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "RequestOptions."
|
||||
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 Response<ClassificationPolicy> createClassificationPolicyWithResponse(CreateClassificationPolicyOptions createClassificationPolicyOptions, RequestOptions requestOptions)"
|
||||
desc: "Create a classification policy."
|
||||
returns:
|
||||
description: "response The response instance."
|
||||
type: "<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.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createDistributionPolicy(com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
name: "createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
summary: "Convenience method to create a distribution policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a distribution policy."
|
||||
name: "createDistributionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions&text=CreateDistributionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DistributionPolicy createDistributionPolicy(CreateDistributionPolicyOptions createDistributionPolicyOptions)"
|
||||
desc: "Convenience method to create a distribution policy."
|
||||
returns:
|
||||
description: "resource The resource instance"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createDistributionPolicyWithResponse(com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions, RequestOptions requestOptions)"
|
||||
name: "createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions, RequestOptions requestOptions)"
|
||||
summary: "Create a distribution policy."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a distribution policy."
|
||||
name: "createDistributionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions&text=CreateDistributionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "RequestOptions."
|
||||
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 Response<DistributionPolicy> createDistributionPolicyWithResponse(CreateDistributionPolicyOptions createDistributionPolicyOptions, RequestOptions requestOptions)"
|
||||
desc: "Create a distribution policy."
|
||||
returns:
|
||||
description: "resource The resource instance"
|
||||
type: "<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.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createExceptionPolicy(com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
name: "createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
summary: "Convenience method to create an exception policy."
|
||||
parameters:
|
||||
- description: "Create options for Exception Policy."
|
||||
name: "createExceptionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions&text=CreateExceptionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ExceptionPolicy createExceptionPolicy(CreateExceptionPolicyOptions createExceptionPolicyOptions)"
|
||||
desc: "Convenience method to create an exception policy."
|
||||
returns:
|
||||
description: "resource The resource instance"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createExceptionPolicyWithResponse(com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions, RequestOptions requestOptions)"
|
||||
name: "createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions, RequestOptions requestOptions)"
|
||||
summary: "Create an exception policy."
|
||||
parameters:
|
||||
- description: "Create options for Exception Policy."
|
||||
name: "createExceptionPolicyOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions&text=CreateExceptionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "RequestOptions."
|
||||
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 Response<ExceptionPolicy> createExceptionPolicyWithResponse(CreateExceptionPolicyOptions createExceptionPolicyOptions, RequestOptions requestOptions)"
|
||||
desc: "Create an exception policy."
|
||||
returns:
|
||||
description: "resource The resource instance"
|
||||
type: "<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.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createQueue(com.azure.communication.jobrouter.models.CreateQueueOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createQueue(CreateQueueOptions createQueueOptions)"
|
||||
name: "createQueue(CreateQueueOptions createQueueOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createQueue(CreateQueueOptions createQueueOptions)"
|
||||
summary: "Convenience method to create a queue."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a queue."
|
||||
name: "createQueueOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterQueue createQueue(CreateQueueOptions createQueueOptions)"
|
||||
desc: "Convenience method to create a queue."
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createQueueWithResponse(com.azure.communication.jobrouter.models.CreateQueueOptions,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.createQueueWithResponse(CreateQueueOptions createQueueOptions, RequestOptions requestOptions)"
|
||||
name: "createQueueWithResponse(CreateQueueOptions createQueueOptions, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.createQueueWithResponse(CreateQueueOptions createQueueOptions, RequestOptions requestOptions)"
|
||||
summary: "Create a queue."
|
||||
parameters:
|
||||
- description: "Container for inputs to create a queue."
|
||||
name: "createQueueOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "RequestOptions."
|
||||
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 Response<RouterQueue> createQueueWithResponse(CreateQueueOptions createQueueOptions, RequestOptions requestOptions)"
|
||||
desc: "Create a queue."
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed."
|
||||
type: "<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.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteClassificationPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteClassificationPolicy(String classificationPolicyId)"
|
||||
name: "deleteClassificationPolicy(String classificationPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteClassificationPolicy(String classificationPolicyId)"
|
||||
summary: "Delete a classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteClassificationPolicy(String classificationPolicyId)"
|
||||
desc: "Delete a classification policy by Id."
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteClassificationPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Delete a classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
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 Response<Void> deleteClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Delete a classification policy by Id."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.deleteDistributionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteDistributionPolicy(String distributionPolicyId)"
|
||||
name: "deleteDistributionPolicy(String distributionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteDistributionPolicy(String distributionPolicyId)"
|
||||
summary: "Delete a distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteDistributionPolicy(String distributionPolicyId)"
|
||||
desc: "Delete a distribution policy by Id."
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteDistributionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Delete a distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
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 Response<Void> deleteDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Delete a distribution policy by Id."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.deleteExceptionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
name: "deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
summary: "Deletes a exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteExceptionPolicy(String exceptionPolicyId)"
|
||||
desc: "Deletes a exception policy by Id."
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteExceptionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
name: "deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Deletes a exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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 Response<Void> deleteExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Deletes a exception policy by Id."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.deleteQueue(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteQueue(String queueId)"
|
||||
name: "deleteQueue(String queueId)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteQueue(String queueId)"
|
||||
summary: "Deletes a queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public void deleteQueue(String queueId)"
|
||||
desc: "Deletes a queue by Id."
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteQueueWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
name: "deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
summary: "Deletes a queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
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 Response<Void> deleteQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
desc: "Deletes a queue by Id."
|
||||
returns:
|
||||
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.getClassificationPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getClassificationPolicy(String classificationPolicyId)"
|
||||
name: "getClassificationPolicy(String classificationPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.getClassificationPolicy(String classificationPolicyId)"
|
||||
summary: "Retrieves an existing classification policy by Id."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ClassificationPolicy getClassificationPolicy(String classificationPolicyId)"
|
||||
desc: "Retrieves an existing classification policy by Id."
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getClassificationPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
name: "getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing classification policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a classification policy."
|
||||
name: "classificationPolicyId"
|
||||
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 Response<BinaryData> getClassificationPolicyWithResponse(String classificationPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing classification policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.getDistributionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getDistributionPolicy(String distributionPolicyId)"
|
||||
name: "getDistributionPolicy(String distributionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.getDistributionPolicy(String distributionPolicyId)"
|
||||
summary: "Retrieves an existing distribution policy by Id."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public DistributionPolicy getDistributionPolicy(String distributionPolicyId)"
|
||||
desc: "Retrieves an existing distribution policy by Id."
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getDistributionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
name: "getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing distribution policy by Id."
|
||||
parameters:
|
||||
- description: "Id of a distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
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 Response<BinaryData> getDistributionPolicyWithResponse(String distributionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing distribution policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.getExceptionPolicy(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getExceptionPolicy(String exceptionPolicyId)"
|
||||
name: "getExceptionPolicy(String exceptionPolicyId)"
|
||||
nameWithType: "JobRouterAdministrationClient.getExceptionPolicy(String exceptionPolicyId)"
|
||||
summary: "Retrieves an existing exception policy by Id."
|
||||
parameters:
|
||||
- description: "The Id of the exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ExceptionPolicy getExceptionPolicy(String exceptionPolicyId)"
|
||||
desc: "Retrieves an existing exception policy by Id."
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getExceptionPolicyWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
name: "getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing exception policy by Id."
|
||||
parameters:
|
||||
- description: "Id of an exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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 Response<BinaryData> getExceptionPolicyWithResponse(String exceptionPolicyId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing exception policy by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n exceptionRules (Optional): [\n (Optional){\n id: String (Required)\n trigger (Required): {\n }\n actions (Required): [\n (Required){\n id: String (Optional)\n }\n ]\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.getQueue(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getQueue(String queueId)"
|
||||
name: "getQueue(String queueId)"
|
||||
nameWithType: "JobRouterAdministrationClient.getQueue(String queueId)"
|
||||
summary: "Retrieves an existing queue by Id."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterQueue getQueue(String queueId)"
|
||||
desc: "Retrieves an existing queue by Id."
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getQueueWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
name: "getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
summary: "Retrieves an existing queue by Id."
|
||||
parameters:
|
||||
- description: "Id of a queue."
|
||||
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 Response<BinaryData> getQueueWithResponse(String queueId, RequestOptions requestOptions)"
|
||||
desc: "Retrieves an existing queue by Id.\n\n**Response Body Schema**\n\n```java\n{\n etag: String (Required)\n id: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.listClassificationPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listClassificationPolicies()"
|
||||
name: "listClassificationPolicies()"
|
||||
nameWithType: "JobRouterAdministrationClient.listClassificationPolicies()"
|
||||
summary: "Retrieves existing classification policies."
|
||||
syntax: "public PagedIterable<ClassificationPolicy> listClassificationPolicies()"
|
||||
desc: "Retrieves existing classification policies."
|
||||
returns:
|
||||
description: "a paged collection of classification policies as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listClassificationPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listClassificationPolicies(RequestOptions requestOptions)"
|
||||
name: "listClassificationPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.listClassificationPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing classification policies."
|
||||
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 PagedIterable<BinaryData> listClassificationPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing classification policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectorAttachments (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of ClassificationPolicy items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" 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.JobRouterAdministrationClient.listDistributionPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listDistributionPolicies()"
|
||||
name: "listDistributionPolicies()"
|
||||
nameWithType: "JobRouterAdministrationClient.listDistributionPolicies()"
|
||||
summary: "Retrieves existing distribution policies."
|
||||
syntax: "public PagedIterable<DistributionPolicy> listDistributionPolicies()"
|
||||
desc: "Retrieves existing distribution policies."
|
||||
returns:
|
||||
description: "a paged collection of distribution policies as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listDistributionPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listDistributionPolicies(RequestOptions requestOptions)"
|
||||
name: "listDistributionPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.listDistributionPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing distribution policies."
|
||||
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 PagedIterable<BinaryData> listDistributionPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing distribution policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of DistributionPolicy items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" 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.JobRouterAdministrationClient.listExceptionPolicies()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listExceptionPolicies()"
|
||||
name: "listExceptionPolicies()"
|
||||
nameWithType: "JobRouterAdministrationClient.listExceptionPolicies()"
|
||||
summary: "Retrieves existing exception policies."
|
||||
syntax: "public PagedIterable<ExceptionPolicy> listExceptionPolicies()"
|
||||
desc: "Retrieves existing exception policies."
|
||||
returns:
|
||||
description: "paged collection of ExceptionPolicy items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listExceptionPolicies(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listExceptionPolicies(RequestOptions requestOptions)"
|
||||
name: "listExceptionPolicies(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.listExceptionPolicies(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing exception policies."
|
||||
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 PagedIterable<BinaryData> listExceptionPolicies(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing exception policies.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n exceptionRules (Optional): [\n (Optional){\n id: String (Required)\n trigger (Required): {\n }\n actions (Required): [\n (Required){\n id: String (Optional)\n }\n ]\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of ExceptionPolicy items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" 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.JobRouterAdministrationClient.listQueues()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listQueues()"
|
||||
name: "listQueues()"
|
||||
nameWithType: "JobRouterAdministrationClient.listQueues()"
|
||||
summary: "Retrieves existing queues."
|
||||
syntax: "public PagedIterable<RouterQueue> listQueues()"
|
||||
desc: "Retrieves existing queues."
|
||||
returns:
|
||||
description: "a paged collection of queues as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listQueues(com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.listQueues(RequestOptions requestOptions)"
|
||||
name: "listQueues(RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.listQueues(RequestOptions requestOptions)"
|
||||
summary: "Retrieves existing queues."
|
||||
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 PagedIterable<BinaryData> listQueues(RequestOptions requestOptions)"
|
||||
desc: "Retrieves existing queues.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\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 name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "paged collection of RouterQueue items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
||||
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" 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.JobRouterAdministrationClient.updateClassificationPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a classification policy."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
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 BinaryData updateClassificationPolicy(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a classification policy.\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 classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "result object."
|
||||
type: "<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.JobRouterAdministrationClient.updateClassificationPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a classification policy."
|
||||
parameters:
|
||||
- description: "Unique identifier of this policy."
|
||||
name: "classificationPolicyId"
|
||||
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 Response<BinaryData> updateClassificationPolicyWithResponse(String classificationPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a classification policy.\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 classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n classificationPolicyId: String (Required)\n name: String (Optional)\n fallbackQueueId: String (Optional)\n queueSelectors (Optional): [\n (Optional){\n }\n ]\n prioritizationRule (Optional): {\n }\n workerSelectors (Optional): [\n (Optional){\n }\n ]\n }\n```"
|
||||
returns:
|
||||
description: "a container for the rules that govern how jobs are classified along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.updateDistributionPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a distribution policy."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
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 BinaryData updateDistributionPolicy(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a distribution policy.\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 distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "result object."
|
||||
type: "<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.JobRouterAdministrationClient.updateDistributionPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a distribution policy."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
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 Response<BinaryData> updateDistributionPolicyWithResponse(String distributionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a distribution policy.\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 distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n distributionPolicyId: String (Required)\n name: String (Optional)\n offerExpiresAfterSeconds: Double (Optional)\n mode (Optional): {\n minConcurrentOffers: Integer (Optional)\n maxConcurrentOffers: Integer (Optional)\n bypassSelectors: Boolean (Optional)\n }\n }\n```"
|
||||
returns:
|
||||
description: "policy governing how jobs are distributed to workers along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.updateExceptionPolicy(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a exception policy."
|
||||
parameters:
|
||||
- description: "The Id of the exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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 BinaryData updateExceptionPolicy(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a exception policy.\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 exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```"
|
||||
returns:
|
||||
description: "result object."
|
||||
type: "<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.JobRouterAdministrationClient.updateExceptionPolicyWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a exception policy."
|
||||
parameters:
|
||||
- description: "The Id of the exception policy."
|
||||
name: "exceptionPolicyId"
|
||||
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 Response<BinaryData> updateExceptionPolicyWithResponse(String exceptionPolicyId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a exception policy.\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 exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n exceptionPolicyId: String (Required)\n name: String (Optional)\n exceptionRules (Optional): {\n String (Optional): {\n trigger (Required): {\n }\n actions (Required): {\n String (Required): {\n }\n }\n }\n }\n }\n```"
|
||||
returns:
|
||||
description: "a policy that defines actions to execute when exception are triggered along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.updateQueue(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a queue."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "RouterQueue resource."
|
||||
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 BinaryData updateQueue(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a queue.\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 queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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.JobRouterAdministrationClient.updateQueueWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClient.updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
name: "updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
nameWithType: "JobRouterAdministrationClient.updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
summary: "Updates a queue."
|
||||
parameters:
|
||||
- description: "The Id of this queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "RouterQueue resource."
|
||||
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 Response<BinaryData> updateQueueWithResponse(String queueId, BinaryData resource, RequestOptions requestOptions)"
|
||||
desc: "Updates a queue.\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 queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n queueId: String (Required)\n name: String (Optional)\n distributionPolicyId: String (Optional)\n labels (Optional): {\n String: Object (Optional)\n }\n exceptionPolicyId: String (Optional)\n }\n```"
|
||||
returns:
|
||||
description: "a queue that can contain jobs to be routed along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
|
||||
type: "<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 synchronous JobRouterAdministrationClient type."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,230 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder"
|
||||
name: "JobRouterAdministrationClientBuilder"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder"
|
||||
summary: "A builder for creating a new instance of the Job<wbr>Router<wbr>Administration<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 **JobRouterAdministrationClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.JobRouterAdministrationClientBuilder()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.JobRouterAdministrationClientBuilder()"
|
||||
name: "JobRouterAdministrationClientBuilder()"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.JobRouterAdministrationClientBuilder()"
|
||||
summary: "Create an instance of the Job<wbr>Router<wbr>Administration<wbr>Client<wbr>Builder."
|
||||
syntax: "public JobRouterAdministrationClientBuilder()"
|
||||
desc: "Create an instance of the JobRouterAdministrationClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "customPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Job<wbr>Router<wbr>Administration<wbr>Async<wbr>Client class."
|
||||
syntax: "public JobRouterAdministrationAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of JobRouterAdministrationAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of JobRouterAdministrationAsyncClient."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient?alt=com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient&text=JobRouterAdministrationAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.buildClient()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Job<wbr>Router<wbr>Administration<wbr>Client class."
|
||||
syntax: "public JobRouterAdministrationClient buildClient()"
|
||||
desc: "Builds an instance of JobRouterAdministrationClient class."
|
||||
returns:
|
||||
description: "an instance of JobRouterAdministrationClient."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClient?alt=com.azure.communication.jobrouter.JobRouterAdministrationClient&text=JobRouterAdministrationClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "clientOptions"
|
||||
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.configuration(Configuration configuration)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "configuration"
|
||||
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.connectionString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.connectionString(String connectionString)"
|
||||
name: "connectionString(String connectionString)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.connectionString(String connectionString)"
|
||||
summary: "Set a connection string for authorization"
|
||||
parameters:
|
||||
- description: "valid connectionString as a string"
|
||||
name: "connectionString"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public JobRouterAdministrationClientBuilder connectionString(String connectionString)"
|
||||
desc: "Set a connection string for authorization"
|
||||
returns:
|
||||
description: "the updated RouterAdministrationClientBuilder object"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.credential(KeyCredential credential)"
|
||||
name: "credential(KeyCredential credential)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.credential(KeyCredential credential)"
|
||||
summary: "Set a key credential for authorization"
|
||||
parameters:
|
||||
- description: "valid credential as a string"
|
||||
name: "credential"
|
||||
type: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder credential(KeyCredential credential)"
|
||||
desc: "Set a key credential for authorization"
|
||||
returns:
|
||||
description: "the updated RouterAdministrationClientBuilder object"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
name: "tokenCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service. Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
||||
returns:
|
||||
description: "Updated <xref uid=\"com.azure.communication.jobrouter.JobRouterClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobRouterClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.endpoint(String endpoint)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "endpoint"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public JobRouterAdministrationClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.httpClient(HttpClient httpClient)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpClient"
|
||||
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpLogOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "pipeline"
|
||||
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "retryOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
parameters:
|
||||
- description: "the retryPolicy value."
|
||||
name: "retryPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the JobRouterAdministrationClientBuilder."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.serviceVersion(com.azure.communication.jobrouter.JobRouterServiceVersion)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder.serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
nameWithType: "JobRouterAdministrationClientBuilder.serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterAdministrationClientBuilder serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the JobRouterAdministrationClientBuilder."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the JobRouterAdministrationClient type."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder?alt=com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder&text=JobRouterAdministrationClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -0,0 +1,230 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.JobRouterClientBuilder"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder"
|
||||
name: "JobRouterClientBuilder"
|
||||
nameWithType: "JobRouterClientBuilder"
|
||||
summary: "A builder for creating a new instance of the 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 **JobRouterClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.JobRouterClientBuilder()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.JobRouterClientBuilder()"
|
||||
name: "JobRouterClientBuilder()"
|
||||
nameWithType: "JobRouterClientBuilder.JobRouterClientBuilder()"
|
||||
summary: "Create an instance of the Job<wbr>Router<wbr>Client<wbr>Builder."
|
||||
syntax: "public JobRouterClientBuilder()"
|
||||
desc: "Create an instance of the JobRouterClientBuilder."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
name: "addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
nameWithType: "JobRouterClientBuilder.addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "customPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder addPolicy(HttpPipelinePolicy customPolicy)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.buildAsyncClient()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.buildAsyncClient()"
|
||||
name: "buildAsyncClient()"
|
||||
nameWithType: "JobRouterClientBuilder.buildAsyncClient()"
|
||||
summary: "Builds an instance of Job<wbr>Router<wbr>Async<wbr>Client class."
|
||||
syntax: "public JobRouterAsyncClient buildAsyncClient()"
|
||||
desc: "Builds an instance of JobRouterAsyncClient class."
|
||||
returns:
|
||||
description: "an instance of JobRouterAsyncClient."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterAsyncClient?alt=com.azure.communication.jobrouter.JobRouterAsyncClient&text=JobRouterAsyncClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.buildClient()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.buildClient()"
|
||||
name: "buildClient()"
|
||||
nameWithType: "JobRouterClientBuilder.buildClient()"
|
||||
summary: "Builds an instance of Job<wbr>Router<wbr>Client class."
|
||||
syntax: "public JobRouterClient buildClient()"
|
||||
desc: "Builds an instance of JobRouterClient class."
|
||||
returns:
|
||||
description: "an instance of JobRouterClient."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClient?alt=com.azure.communication.jobrouter.JobRouterClient&text=JobRouterClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
name: "clientOptions(ClientOptions clientOptions)"
|
||||
nameWithType: "JobRouterClientBuilder.clientOptions(ClientOptions clientOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "clientOptions"
|
||||
type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder clientOptions(ClientOptions clientOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.configuration(com.azure.core.util.Configuration)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.configuration(Configuration configuration)"
|
||||
name: "configuration(Configuration configuration)"
|
||||
nameWithType: "JobRouterClientBuilder.configuration(Configuration configuration)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "configuration"
|
||||
type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder configuration(Configuration configuration)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.connectionString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.connectionString(String connectionString)"
|
||||
name: "connectionString(String connectionString)"
|
||||
nameWithType: "JobRouterClientBuilder.connectionString(String connectionString)"
|
||||
summary: "Set a connection string for authorization"
|
||||
parameters:
|
||||
- description: "valid token credential as a string"
|
||||
name: "connectionString"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public JobRouterClientBuilder connectionString(String connectionString)"
|
||||
desc: "Set a connection string for authorization"
|
||||
returns:
|
||||
description: "the updated RouterClientBuilder object"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.credential(com.azure.core.credential.KeyCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.credential(KeyCredential credential)"
|
||||
name: "credential(KeyCredential credential)"
|
||||
nameWithType: "JobRouterClientBuilder.credential(KeyCredential credential)"
|
||||
summary: "Set a key credential for authorization"
|
||||
parameters:
|
||||
- description: "valid credential as a string"
|
||||
name: "credential"
|
||||
type: "<xref href=\"com.azure.core.credential.KeyCredential?alt=com.azure.core.credential.KeyCredential&text=KeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder credential(KeyCredential credential)"
|
||||
desc: "Set a key credential for authorization"
|
||||
returns:
|
||||
description: "the updated RouterClientBuilder object"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.credential(com.azure.core.credential.TokenCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
name: "credential(TokenCredential tokenCredential)"
|
||||
nameWithType: "JobRouterClientBuilder.credential(TokenCredential tokenCredential)"
|
||||
summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
parameters:
|
||||
- description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
|
||||
name: "tokenCredential"
|
||||
type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder credential(TokenCredential tokenCredential)"
|
||||
desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service. Refer to the Azure SDK for Java [identity and authentication][] documentation for more details on proper usage of the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
|
||||
returns:
|
||||
description: "Updated <xref uid=\"com.azure.communication.jobrouter.JobRouterClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobRouterClientBuilder\"></xref> object."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.endpoint(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.endpoint(String endpoint)"
|
||||
name: "endpoint(String endpoint)"
|
||||
nameWithType: "JobRouterClientBuilder.endpoint(String endpoint)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "endpoint"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public JobRouterClientBuilder endpoint(String endpoint)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.httpClient(com.azure.core.http.HttpClient)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.httpClient(HttpClient httpClient)"
|
||||
name: "httpClient(HttpClient httpClient)"
|
||||
nameWithType: "JobRouterClientBuilder.httpClient(HttpClient httpClient)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpClient"
|
||||
type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder httpClient(HttpClient httpClient)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
name: "httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
nameWithType: "JobRouterClientBuilder.httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "httpLogOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
name: "pipeline(HttpPipeline pipeline)"
|
||||
nameWithType: "JobRouterClientBuilder.pipeline(HttpPipeline pipeline)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "pipeline"
|
||||
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder pipeline(HttpPipeline pipeline)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
name: "retryOptions(RetryOptions retryOptions)"
|
||||
nameWithType: "JobRouterClientBuilder.retryOptions(RetryOptions retryOptions)"
|
||||
summary: "."
|
||||
parameters:
|
||||
- name: "retryOptions"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder retryOptions(RetryOptions retryOptions)"
|
||||
desc: "."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
name: "retryPolicy(RetryPolicy retryPolicy)"
|
||||
nameWithType: "JobRouterClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
|
||||
summary: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
parameters:
|
||||
- description: "the retryPolicy value."
|
||||
name: "retryPolicy"
|
||||
type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder retryPolicy(RetryPolicy retryPolicy)"
|
||||
desc: "Sets The retry policy that will attempt to retry failed requests, if applicable."
|
||||
returns:
|
||||
description: "the JobRouterClientBuilder."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterClientBuilder.serviceVersion(com.azure.communication.jobrouter.JobRouterServiceVersion)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterClientBuilder.serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
name: "serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
nameWithType: "JobRouterClientBuilder.serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
summary: "Sets Service version."
|
||||
parameters:
|
||||
- description: "the serviceVersion value."
|
||||
name: "serviceVersion"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public JobRouterClientBuilder serviceVersion(JobRouterServiceVersion serviceVersion)"
|
||||
desc: "Sets Service version."
|
||||
returns:
|
||||
description: "the JobRouterClientBuilder."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A builder for creating a new instance of the JobRouterClient type."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.ConnectionStringTrait?alt=com.azure.core.client.traits.ConnectionStringTrait&text=ConnectionStringTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.KeyCredentialTrait?alt=com.azure.core.client.traits.KeyCredentialTrait&text=KeyCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.JobRouterClientBuilder?alt=com.azure.communication.jobrouter.JobRouterClientBuilder&text=JobRouterClientBuilder\" data-throw-if-not-resolved=\"False\" />>"
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaEnum
|
||||
uid: "com.azure.communication.jobrouter.JobRouterServiceVersion"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion"
|
||||
name: "JobRouterServiceVersion"
|
||||
nameWithType: "JobRouterServiceVersion"
|
||||
summary: "Service version of Job<wbr>Router<wbr>Client."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
||||
methodsRef:
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
||||
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
||||
- 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#getClass--\">getClass</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#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 enum **JobRouterServiceVersion**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />></br> implements <xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterServiceVersion.V2023_11_01"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion.V2023_11_01"
|
||||
name: "V2023_11_01"
|
||||
nameWithType: "JobRouterServiceVersion.V2023_11_01"
|
||||
summary: "Enum value 2023-11-01."
|
||||
desc: "Enum value 2023-11-01."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterServiceVersion.getLatest()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion.getLatest()"
|
||||
name: "getLatest()"
|
||||
nameWithType: "JobRouterServiceVersion.getLatest()"
|
||||
summary: "Gets the latest service version supported by this client library."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static JobRouterServiceVersion getLatest()"
|
||||
desc: "Gets the latest service version supported by this client library."
|
||||
returns:
|
||||
description: "The latest <xref uid=\"com.azure.communication.jobrouter.JobRouterServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"JobRouterServiceVersion\"></xref>."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterServiceVersion.getVersion()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion.getVersion()"
|
||||
name: "getVersion()"
|
||||
nameWithType: "JobRouterServiceVersion.getVersion()"
|
||||
syntax: "public String getVersion()"
|
||||
returns:
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterServiceVersion.valueOf(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion.valueOf(String name)"
|
||||
name: "valueOf(String name)"
|
||||
nameWithType: "JobRouterServiceVersion.valueOf(String name)"
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static JobRouterServiceVersion valueOf(String name)"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.JobRouterServiceVersion.values()"
|
||||
fullName: "com.azure.communication.jobrouter.JobRouterServiceVersion.values()"
|
||||
name: "values()"
|
||||
nameWithType: "JobRouterServiceVersion.values()"
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static JobRouterServiceVersion[] values()"
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.JobRouterServiceVersion?alt=com.azure.communication.jobrouter.JobRouterServiceVersion&text=JobRouterServiceVersion\" data-throw-if-not-resolved=\"False\" />[]"
|
||||
desc: "Service version of JobRouterClient."
|
||||
implements:
|
||||
- "<xref href=\"com.azure.core.util.ServiceVersion?alt=com.azure.core.util.ServiceVersion&text=ServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.AcceptJobOfferResult"
|
||||
fullName: "com.azure.communication.jobrouter.models.AcceptJobOfferResult"
|
||||
name: "AcceptJobOfferResult"
|
||||
nameWithType: "AcceptJobOfferResult"
|
||||
summary: "Response containing ids for the worker, job, and assignment from an accepted offer."
|
||||
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 **AcceptJobOfferResult**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getAssignmentId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getAssignmentId()"
|
||||
name: "getAssignmentId()"
|
||||
nameWithType: "AcceptJobOfferResult.getAssignmentId()"
|
||||
summary: "Get the assignment<wbr>Id property: Id of job assignment that assigns a worker that has accepted an offer to a job."
|
||||
syntax: "public String getAssignmentId()"
|
||||
desc: "Get the assignmentId property: Id of job assignment that assigns a worker that has accepted an offer to a job."
|
||||
returns:
|
||||
description: "the assignmentId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "AcceptJobOfferResult.getJobId()"
|
||||
summary: "Get the job<wbr>Id property: Id of the job assigned."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get the jobId property: Id of the job assigned."
|
||||
returns:
|
||||
description: "the jobId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getWorkerId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.AcceptJobOfferResult.getWorkerId()"
|
||||
name: "getWorkerId()"
|
||||
nameWithType: "AcceptJobOfferResult.getWorkerId()"
|
||||
summary: "Get the worker<wbr>Id property: Id of the worker that has been assigned this job."
|
||||
syntax: "public String getWorkerId()"
|
||||
desc: "Get the workerId property: Id of the worker that has been assigned this job."
|
||||
returns:
|
||||
description: "the workerId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Response containing ids for the worker, job, and assignment from an accepted offer."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.BestWorkerMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode"
|
||||
name: "BestWorkerMode"
|
||||
nameWithType: "BestWorkerMode"
|
||||
summary: "Jobs are distributed to the worker with the strongest abilities available."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getKind()?alt=com.azure.communication.jobrouter.models.DistributionMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers&text=getMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers&text=getMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors()?alt=com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors&text=isBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)?alt=com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors&text=setBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers&text=setMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers&text=setMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **BestWorkerMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.BestWorkerMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.BestWorkerMode()"
|
||||
name: "BestWorkerMode()"
|
||||
nameWithType: "BestWorkerMode.BestWorkerMode()"
|
||||
summary: "Creates an instance of Best<wbr>Worker<wbr>Mode class."
|
||||
syntax: "public BestWorkerMode()"
|
||||
desc: "Creates an instance of BestWorkerMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.getScoringRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.getScoringRule()"
|
||||
name: "getScoringRule()"
|
||||
nameWithType: "BestWorkerMode.getScoringRule()"
|
||||
summary: "Get the scoring<wbr>Rule property: Define a scoring rule to use, when calculating a score to determine the best worker."
|
||||
syntax: "public RouterRule getScoringRule()"
|
||||
desc: "Get the scoringRule property: Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic\\_function)."
|
||||
returns:
|
||||
description: "the scoringRule value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.getScoringRuleOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.getScoringRuleOptions()"
|
||||
name: "getScoringRuleOptions()"
|
||||
nameWithType: "BestWorkerMode.getScoringRuleOptions()"
|
||||
summary: "Get the scoring<wbr>Rule<wbr>Options property: Options to configure 'scoring<wbr>Rule'."
|
||||
syntax: "public ScoringRuleOptions getScoringRuleOptions()"
|
||||
desc: "Get the scoringRuleOptions property: Options to configure 'scoringRule'. If not set, default values are used."
|
||||
returns:
|
||||
description: "the scoringRuleOptions value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.setBypassSelectors(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
name: "setBypassSelectors(Boolean bypassSelectors)"
|
||||
nameWithType: "BestWorkerMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
summary: "Set the bypass<wbr>Selectors property: If set to true, then router will match workers to jobs even if they don't match label selectors."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)"
|
||||
parameters:
|
||||
- name: "bypassSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public BestWorkerMode setBypassSelectors(Boolean bypassSelectors)"
|
||||
desc: "Set the bypassSelectors property: If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.BestWorkerMode?alt=com.azure.communication.jobrouter.models.BestWorkerMode&text=BestWorkerMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
name: "setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
nameWithType: "BestWorkerMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
summary: "Set the max<wbr>Concurrent<wbr>Offers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "maxConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public BestWorkerMode setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
desc: "Set the maxConcurrentOffers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.BestWorkerMode?alt=com.azure.communication.jobrouter.models.BestWorkerMode&text=BestWorkerMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
name: "setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
nameWithType: "BestWorkerMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
summary: "Set the min<wbr>Concurrent<wbr>Offers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "minConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public BestWorkerMode setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
desc: "Set the minConcurrentOffers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.BestWorkerMode?alt=com.azure.communication.jobrouter.models.BestWorkerMode&text=BestWorkerMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.setScoringRule(com.azure.communication.jobrouter.models.RouterRule)"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.setScoringRule(RouterRule scoringRule)"
|
||||
name: "setScoringRule(RouterRule scoringRule)"
|
||||
nameWithType: "BestWorkerMode.setScoringRule(RouterRule scoringRule)"
|
||||
summary: "Set the scoring<wbr>Rule property: Define a scoring rule to use, when calculating a score to determine the best worker."
|
||||
parameters:
|
||||
- description: "the scoringRule value to set."
|
||||
name: "scoringRule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public BestWorkerMode setScoringRule(RouterRule scoringRule)"
|
||||
desc: "Set the scoringRule property: Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic\\_function)."
|
||||
returns:
|
||||
description: "the BestWorkerMode object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.BestWorkerMode?alt=com.azure.communication.jobrouter.models.BestWorkerMode&text=BestWorkerMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.BestWorkerMode.setScoringRuleOptions(com.azure.communication.jobrouter.models.ScoringRuleOptions)"
|
||||
fullName: "com.azure.communication.jobrouter.models.BestWorkerMode.setScoringRuleOptions(ScoringRuleOptions scoringRuleOptions)"
|
||||
name: "setScoringRuleOptions(ScoringRuleOptions scoringRuleOptions)"
|
||||
nameWithType: "BestWorkerMode.setScoringRuleOptions(ScoringRuleOptions scoringRuleOptions)"
|
||||
summary: "Set the scoring<wbr>Rule<wbr>Options property: Options to configure 'scoring<wbr>Rule'."
|
||||
parameters:
|
||||
- description: "the scoringRuleOptions value to set."
|
||||
name: "scoringRuleOptions"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public BestWorkerMode setScoringRuleOptions(ScoringRuleOptions scoringRuleOptions)"
|
||||
desc: "Set the scoringRuleOptions property: Options to configure 'scoringRule'. If not set, default values are used."
|
||||
returns:
|
||||
description: "the BestWorkerMode object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.BestWorkerMode?alt=com.azure.communication.jobrouter.models.BestWorkerMode&text=BestWorkerMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Jobs are distributed to the worker with the strongest abilities available."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CancelExceptionAction"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction"
|
||||
name: "CancelExceptionAction"
|
||||
nameWithType: "CancelExceptionAction"
|
||||
summary: "An action that marks a job as cancelled."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getId()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getKind()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **CancelExceptionAction**</br> extends <xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelExceptionAction.CancelExceptionAction()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction.CancelExceptionAction()"
|
||||
name: "CancelExceptionAction()"
|
||||
nameWithType: "CancelExceptionAction.CancelExceptionAction()"
|
||||
summary: "Creates an instance of Cancel<wbr>Exception<wbr>Action class."
|
||||
syntax: "public CancelExceptionAction()"
|
||||
desc: "Creates an instance of CancelExceptionAction class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelExceptionAction.getDispositionCode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction.getDispositionCode()"
|
||||
name: "getDispositionCode()"
|
||||
nameWithType: "CancelExceptionAction.getDispositionCode()"
|
||||
summary: "Get the disposition<wbr>Code property: (Optional) Indicates the outcome of the job, populate this field with your own custom values."
|
||||
syntax: "public String getDispositionCode()"
|
||||
desc: "Get the dispositionCode property: (Optional) Indicates the outcome of the job, populate this field with your own custom values."
|
||||
returns:
|
||||
description: "the dispositionCode value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelExceptionAction.getNote()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction.getNote()"
|
||||
name: "getNote()"
|
||||
nameWithType: "CancelExceptionAction.getNote()"
|
||||
summary: "Get the note property: (Optional) A note that will be appended to the jobs' Notes collection with the current timestamp."
|
||||
syntax: "public String getNote()"
|
||||
desc: "Get the note property: (Optional) A note that will be appended to the jobs' Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the note value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelExceptionAction.setDispositionCode(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction.setDispositionCode(String dispositionCode)"
|
||||
name: "setDispositionCode(String dispositionCode)"
|
||||
nameWithType: "CancelExceptionAction.setDispositionCode(String dispositionCode)"
|
||||
summary: "Set the disposition<wbr>Code property: (Optional) Indicates the outcome of the job, populate this field with your own custom values."
|
||||
parameters:
|
||||
- description: "the dispositionCode value to set."
|
||||
name: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CancelExceptionAction setDispositionCode(String dispositionCode)"
|
||||
desc: "Set the dispositionCode property: (Optional) Indicates the outcome of the job, populate this field with your own custom values."
|
||||
returns:
|
||||
description: "the CancelExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CancelExceptionAction?alt=com.azure.communication.jobrouter.models.CancelExceptionAction&text=CancelExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelExceptionAction.setNote(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelExceptionAction.setNote(String note)"
|
||||
name: "setNote(String note)"
|
||||
nameWithType: "CancelExceptionAction.setNote(String note)"
|
||||
summary: "Set the note property: (Optional) A note that will be appended to the jobs' Notes collection with the current timestamp."
|
||||
parameters:
|
||||
- description: "the note value to set."
|
||||
name: "note"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CancelExceptionAction setNote(String note)"
|
||||
desc: "Set the note property: (Optional) A note that will be appended to the jobs' Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the CancelExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CancelExceptionAction?alt=com.azure.communication.jobrouter.models.CancelExceptionAction&text=CancelExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "An action that marks a job as cancelled."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CancelJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions"
|
||||
name: "CancelJobOptions"
|
||||
nameWithType: "CancelJobOptions"
|
||||
summary: "Request payload for cancelling a job."
|
||||
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 **CancelJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelJobOptions.CancelJobOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions.CancelJobOptions()"
|
||||
name: "CancelJobOptions()"
|
||||
nameWithType: "CancelJobOptions.CancelJobOptions()"
|
||||
summary: "Creates an instance of Cancel<wbr>Job<wbr>Options<wbr>Internal class."
|
||||
syntax: "public CancelJobOptions()"
|
||||
desc: "Creates an instance of CancelJobOptionsInternal class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelJobOptions.getDispositionCode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions.getDispositionCode()"
|
||||
name: "getDispositionCode()"
|
||||
nameWithType: "CancelJobOptions.getDispositionCode()"
|
||||
summary: "Get the disposition<wbr>Code property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
syntax: "public String getDispositionCode()"
|
||||
desc: "Get the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of \"Cancelled\" is set."
|
||||
returns:
|
||||
description: "the dispositionCode value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelJobOptions.getNote()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions.getNote()"
|
||||
name: "getNote()"
|
||||
nameWithType: "CancelJobOptions.getNote()"
|
||||
summary: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
syntax: "public String getNote()"
|
||||
desc: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the note value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelJobOptions.setDispositionCode(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions.setDispositionCode(String dispositionCode)"
|
||||
name: "setDispositionCode(String dispositionCode)"
|
||||
nameWithType: "CancelJobOptions.setDispositionCode(String dispositionCode)"
|
||||
summary: "Set the disposition<wbr>Code property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
parameters:
|
||||
- description: "the dispositionCode value to set."
|
||||
name: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CancelJobOptions setDispositionCode(String dispositionCode)"
|
||||
desc: "Set the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of \"Cancelled\" is set."
|
||||
returns:
|
||||
description: "the CancelJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CancelJobOptions?alt=com.azure.communication.jobrouter.models.CancelJobOptions&text=CancelJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CancelJobOptions.setNote(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CancelJobOptions.setNote(String note)"
|
||||
name: "setNote(String note)"
|
||||
nameWithType: "CancelJobOptions.setNote(String note)"
|
||||
summary: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
parameters:
|
||||
- description: "the note value to set."
|
||||
name: "note"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CancelJobOptions setNote(String note)"
|
||||
desc: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the CancelJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CancelJobOptions?alt=com.azure.communication.jobrouter.models.CancelJobOptions&text=CancelJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request payload for cancelling a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ClassificationPolicy"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy"
|
||||
name: "ClassificationPolicy"
|
||||
nameWithType: "ClassificationPolicy"
|
||||
summary: "A container for the rules that govern how jobs are classified."
|
||||
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 **ClassificationPolicy**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.ClassificationPolicy()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.ClassificationPolicy()"
|
||||
name: "ClassificationPolicy()"
|
||||
nameWithType: "ClassificationPolicy.ClassificationPolicy()"
|
||||
summary: "Creates an instance of Classification<wbr>Policy class."
|
||||
syntax: "public ClassificationPolicy()"
|
||||
desc: "Creates an instance of ClassificationPolicy class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "ClassificationPolicy.getEtag()"
|
||||
summary: "Get the etag property: The entity tag for this resource."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: The entity tag for this resource."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getFallbackQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getFallbackQueueId()"
|
||||
name: "getFallbackQueueId()"
|
||||
nameWithType: "ClassificationPolicy.getFallbackQueueId()"
|
||||
summary: "Get the fallback<wbr>Queue<wbr>Id property: Id of a fallback queue to select if queue selector attachments doesn't find a match."
|
||||
syntax: "public String getFallbackQueueId()"
|
||||
desc: "Get the fallbackQueueId property: Id of a fallback queue to select if queue selector attachments doesn't find a match."
|
||||
returns:
|
||||
description: "the fallbackQueueId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "ClassificationPolicy.getId()"
|
||||
summary: "Get the id property: Id of a classification policy."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: Id of a classification policy."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "ClassificationPolicy.getName()"
|
||||
summary: "Get the name property: Friendly name of this policy."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: Friendly name of this policy."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getPrioritizationRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getPrioritizationRule()"
|
||||
name: "getPrioritizationRule()"
|
||||
nameWithType: "ClassificationPolicy.getPrioritizationRule()"
|
||||
summary: "Get the prioritization<wbr>Rule property: A rule to determine a priority score for a job."
|
||||
syntax: "public RouterRule getPrioritizationRule()"
|
||||
desc: "Get the prioritizationRule property: A rule to determine a priority score for a job."
|
||||
returns:
|
||||
description: "the prioritizationRule value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getQueueSelectorAttachments()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getQueueSelectorAttachments()"
|
||||
name: "getQueueSelectorAttachments()"
|
||||
nameWithType: "ClassificationPolicy.getQueueSelectorAttachments()"
|
||||
summary: "Get the queue<wbr>Selector<wbr>Attachments property: Queue selector attachments used to resolve a queue for a job."
|
||||
syntax: "public List<QueueSelectorAttachment> getQueueSelectorAttachments()"
|
||||
desc: "Get the queueSelectorAttachments property: Queue selector attachments used to resolve a queue for a job."
|
||||
returns:
|
||||
description: "the queueSelectorAttachments value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.getWorkerSelectorAttachments()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.getWorkerSelectorAttachments()"
|
||||
name: "getWorkerSelectorAttachments()"
|
||||
nameWithType: "ClassificationPolicy.getWorkerSelectorAttachments()"
|
||||
summary: "Get the worker<wbr>Selector<wbr>Attachments property: Worker selector attachments used to attach worker selectors to a job."
|
||||
syntax: "public List<WorkerSelectorAttachment> getWorkerSelectorAttachments()"
|
||||
desc: "Get the workerSelectorAttachments property: Worker selector attachments used to attach worker selectors to a job."
|
||||
returns:
|
||||
description: "the workerSelectorAttachments value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.setFallbackQueueId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.setFallbackQueueId(String fallbackQueueId)"
|
||||
name: "setFallbackQueueId(String fallbackQueueId)"
|
||||
nameWithType: "ClassificationPolicy.setFallbackQueueId(String fallbackQueueId)"
|
||||
summary: "Set the fallback<wbr>Queue<wbr>Id property: Id of a fallback queue to select if queue selector attachments doesn't find a match."
|
||||
parameters:
|
||||
- description: "the fallbackQueueId value to set."
|
||||
name: "fallbackQueueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ClassificationPolicy setFallbackQueueId(String fallbackQueueId)"
|
||||
desc: "Set the fallbackQueueId property: Id of a fallback queue to select if queue selector attachments doesn't find a match."
|
||||
returns:
|
||||
description: "the ClassificationPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "ClassificationPolicy.setName(String name)"
|
||||
summary: "Set the name property: Friendly name of this policy."
|
||||
parameters:
|
||||
- description: "the name value to set."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ClassificationPolicy setName(String name)"
|
||||
desc: "Set the name property: Friendly name of this policy."
|
||||
returns:
|
||||
description: "the ClassificationPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.setPrioritizationRule(com.azure.communication.jobrouter.models.RouterRule)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
name: "setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
nameWithType: "ClassificationPolicy.setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
summary: "Set the prioritization<wbr>Rule property: A rule to determine a priority score for a job."
|
||||
parameters:
|
||||
- description: "the prioritizationRule value to set."
|
||||
name: "prioritizationRule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public ClassificationPolicy setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
desc: "Set the prioritizationRule property: A rule to determine a priority score for a job."
|
||||
returns:
|
||||
description: "the ClassificationPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.setQueueSelectorAttachments(java.util.List<com.azure.communication.jobrouter.models.QueueSelectorAttachment>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.setQueueSelectorAttachments(List<QueueSelectorAttachment> queueSelectorAttachments)"
|
||||
name: "setQueueSelectorAttachments(List<QueueSelectorAttachment> queueSelectorAttachments)"
|
||||
nameWithType: "ClassificationPolicy.setQueueSelectorAttachments(List<QueueSelectorAttachment> queueSelectorAttachments)"
|
||||
summary: "Set the queue<wbr>Selector<wbr>Attachments property: Queue selector attachments used to resolve a queue for a job."
|
||||
parameters:
|
||||
- description: "the queueSelectorAttachments value to set."
|
||||
name: "queueSelectorAttachments"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ClassificationPolicy setQueueSelectorAttachments(List<QueueSelectorAttachment> queueSelectorAttachments)"
|
||||
desc: "Set the queueSelectorAttachments property: Queue selector attachments used to resolve a queue for a job."
|
||||
returns:
|
||||
description: "the ClassificationPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ClassificationPolicy.setWorkerSelectorAttachments(java.util.List<com.azure.communication.jobrouter.models.WorkerSelectorAttachment>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ClassificationPolicy.setWorkerSelectorAttachments(List<WorkerSelectorAttachment> workerSelectorAttachments)"
|
||||
name: "setWorkerSelectorAttachments(List<WorkerSelectorAttachment> workerSelectorAttachments)"
|
||||
nameWithType: "ClassificationPolicy.setWorkerSelectorAttachments(List<WorkerSelectorAttachment> workerSelectorAttachments)"
|
||||
summary: "Set the worker<wbr>Selector<wbr>Attachments property: Worker selector attachments used to attach worker selectors to a job."
|
||||
parameters:
|
||||
- description: "the workerSelectorAttachments value to set."
|
||||
name: "workerSelectorAttachments"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ClassificationPolicy setWorkerSelectorAttachments(List<WorkerSelectorAttachment> workerSelectorAttachments)"
|
||||
desc: "Set the workerSelectorAttachments property: Worker selector attachments used to attach worker selectors to a job."
|
||||
returns:
|
||||
description: "the ClassificationPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ClassificationPolicy?alt=com.azure.communication.jobrouter.models.ClassificationPolicy&text=ClassificationPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A container for the rules that govern how jobs are classified."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CloseJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions"
|
||||
name: "CloseJobOptions"
|
||||
nameWithType: "CloseJobOptions"
|
||||
summary: "Request payload for closing jobs."
|
||||
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 **CloseJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.CloseJobOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.CloseJobOptions()"
|
||||
name: "CloseJobOptions()"
|
||||
nameWithType: "CloseJobOptions.CloseJobOptions()"
|
||||
summary: "Creates an instance of Close<wbr>Job<wbr>Options<wbr>Internal class."
|
||||
syntax: "public CloseJobOptions()"
|
||||
desc: "Creates an instance of CloseJobOptionsInternal class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.getCloseAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.getCloseAt()"
|
||||
name: "getCloseAt()"
|
||||
nameWithType: "CloseJobOptions.getCloseAt()"
|
||||
summary: "Get the close<wbr>At property: If not provided, worker capacity is released immediately along with a Job<wbr>Closed<wbr>Event notification."
|
||||
syntax: "public OffsetDateTime getCloseAt()"
|
||||
desc: "Get the closeAt property: If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC."
|
||||
returns:
|
||||
description: "the closeAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.getDispositionCode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.getDispositionCode()"
|
||||
name: "getDispositionCode()"
|
||||
nameWithType: "CloseJobOptions.getDispositionCode()"
|
||||
summary: "Get the disposition<wbr>Code property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
syntax: "public String getDispositionCode()"
|
||||
desc: "Get the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
returns:
|
||||
description: "the dispositionCode value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.getNote()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.getNote()"
|
||||
name: "getNote()"
|
||||
nameWithType: "CloseJobOptions.getNote()"
|
||||
summary: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
syntax: "public String getNote()"
|
||||
desc: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the note value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.setCloseAt(java.time.OffsetDateTime)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.setCloseAt(OffsetDateTime closeAt)"
|
||||
name: "setCloseAt(OffsetDateTime closeAt)"
|
||||
nameWithType: "CloseJobOptions.setCloseAt(OffsetDateTime closeAt)"
|
||||
summary: "Set the close<wbr>At property: If not provided, worker capacity is released immediately along with a Job<wbr>Closed<wbr>Event notification."
|
||||
parameters:
|
||||
- description: "the closeAt value to set."
|
||||
name: "closeAt"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
syntax: "public CloseJobOptions setCloseAt(OffsetDateTime closeAt)"
|
||||
desc: "Set the closeAt property: If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC."
|
||||
returns:
|
||||
description: "the CloseJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CloseJobOptions?alt=com.azure.communication.jobrouter.models.CloseJobOptions&text=CloseJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.setDispositionCode(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.setDispositionCode(String dispositionCode)"
|
||||
name: "setDispositionCode(String dispositionCode)"
|
||||
nameWithType: "CloseJobOptions.setDispositionCode(String dispositionCode)"
|
||||
summary: "Set the disposition<wbr>Code property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
parameters:
|
||||
- description: "the dispositionCode value to set."
|
||||
name: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CloseJobOptions setDispositionCode(String dispositionCode)"
|
||||
desc: "Set the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom values."
|
||||
returns:
|
||||
description: "the CloseJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CloseJobOptions?alt=com.azure.communication.jobrouter.models.CloseJobOptions&text=CloseJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CloseJobOptions.setNote(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CloseJobOptions.setNote(String note)"
|
||||
name: "setNote(String note)"
|
||||
nameWithType: "CloseJobOptions.setNote(String note)"
|
||||
summary: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
parameters:
|
||||
- description: "the note value to set."
|
||||
name: "note"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CloseJobOptions setNote(String note)"
|
||||
desc: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the CloseJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CloseJobOptions?alt=com.azure.communication.jobrouter.models.CloseJobOptions&text=CloseJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request payload for closing jobs."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CompleteJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CompleteJobOptions"
|
||||
name: "CompleteJobOptions"
|
||||
nameWithType: "CompleteJobOptions"
|
||||
summary: "Request payload for completing jobs."
|
||||
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 **CompleteJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CompleteJobOptions.CompleteJobOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CompleteJobOptions.CompleteJobOptions()"
|
||||
name: "CompleteJobOptions()"
|
||||
nameWithType: "CompleteJobOptions.CompleteJobOptions()"
|
||||
summary: "Creates an instance of Complete<wbr>Job<wbr>Options<wbr>Internal class."
|
||||
syntax: "public CompleteJobOptions()"
|
||||
desc: "Creates an instance of CompleteJobOptionsInternal class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CompleteJobOptions.getNote()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CompleteJobOptions.getNote()"
|
||||
name: "getNote()"
|
||||
nameWithType: "CompleteJobOptions.getNote()"
|
||||
summary: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
syntax: "public String getNote()"
|
||||
desc: "Get the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the note value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CompleteJobOptions.setNote(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CompleteJobOptions.setNote(String note)"
|
||||
name: "setNote(String note)"
|
||||
nameWithType: "CompleteJobOptions.setNote(String note)"
|
||||
summary: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
parameters:
|
||||
- description: "the note value to set."
|
||||
name: "note"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CompleteJobOptions setNote(String note)"
|
||||
desc: "Set the note property: A note that will be appended to a job's Notes collection with the current timestamp."
|
||||
returns:
|
||||
description: "the CompleteJobOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CompleteJobOptions?alt=com.azure.communication.jobrouter.models.CompleteJobOptions&text=CompleteJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request payload for completing jobs."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment"
|
||||
name: "ConditionalQueueSelectorAttachment"
|
||||
nameWithType: "ConditionalQueueSelectorAttachment"
|
||||
summary: "Describes a set of queue selectors that will be attached if the given condition resolves to true."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ConditionalQueueSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.ConditionalQueueSelectorAttachment(com.azure.communication.jobrouter.models.RouterRule,java.util.List<com.azure.communication.jobrouter.models.RouterQueueSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.ConditionalQueueSelectorAttachment(RouterRule condition, List<RouterQueueSelector> queueSelectors)"
|
||||
name: "ConditionalQueueSelectorAttachment(RouterRule condition, List<RouterQueueSelector> queueSelectors)"
|
||||
nameWithType: "ConditionalQueueSelectorAttachment.ConditionalQueueSelectorAttachment(RouterRule condition, List<RouterQueueSelector> queueSelectors)"
|
||||
summary: "Creates an instance of Conditional<wbr>Queue<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the condition value to set."
|
||||
name: "condition"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the queueSelectors value to set."
|
||||
name: "queueSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ConditionalQueueSelectorAttachment(RouterRule condition, List<RouterQueueSelector> queueSelectors)"
|
||||
desc: "Creates an instance of ConditionalQueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.getCondition()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.getCondition()"
|
||||
name: "getCondition()"
|
||||
nameWithType: "ConditionalQueueSelectorAttachment.getCondition()"
|
||||
summary: "Get the condition property: A rule of one of the following types:"
|
||||
syntax: "public RouterRule getCondition()"
|
||||
desc: "Get the condition property: A rule of one of the following types:\n\nStaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol."
|
||||
returns:
|
||||
description: "the condition value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.getQueueSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment.getQueueSelectors()"
|
||||
name: "getQueueSelectors()"
|
||||
nameWithType: "ConditionalQueueSelectorAttachment.getQueueSelectors()"
|
||||
summary: "Get the queue<wbr>Selectors property: The queue selectors to attach."
|
||||
syntax: "public List<RouterQueueSelector> getQueueSelectors()"
|
||||
desc: "Get the queueSelectors property: The queue selectors to attach."
|
||||
returns:
|
||||
description: "the queueSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes a set of queue selectors that will be attached if the given condition resolves to true."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment"
|
||||
name: "ConditionalWorkerSelectorAttachment"
|
||||
nameWithType: "ConditionalWorkerSelectorAttachment"
|
||||
summary: "Describes a set of worker selectors that will be attached if the given condition resolves to true."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ConditionalWorkerSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.ConditionalWorkerSelectorAttachment(com.azure.communication.jobrouter.models.RouterRule,java.util.List<com.azure.communication.jobrouter.models.RouterWorkerSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.ConditionalWorkerSelectorAttachment(RouterRule condition, List<RouterWorkerSelector> workerSelectors)"
|
||||
name: "ConditionalWorkerSelectorAttachment(RouterRule condition, List<RouterWorkerSelector> workerSelectors)"
|
||||
nameWithType: "ConditionalWorkerSelectorAttachment.ConditionalWorkerSelectorAttachment(RouterRule condition, List<RouterWorkerSelector> workerSelectors)"
|
||||
summary: "Creates an instance of Conditional<wbr>Worker<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the condition value to set."
|
||||
name: "condition"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the workerSelectors value to set."
|
||||
name: "workerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ConditionalWorkerSelectorAttachment(RouterRule condition, List<RouterWorkerSelector> workerSelectors)"
|
||||
desc: "Creates an instance of ConditionalWorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.getCondition()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.getCondition()"
|
||||
name: "getCondition()"
|
||||
nameWithType: "ConditionalWorkerSelectorAttachment.getCondition()"
|
||||
summary: "Get the condition property: A rule of one of the following types:"
|
||||
syntax: "public RouterRule getCondition()"
|
||||
desc: "Get the condition property: A rule of one of the following types:\n\nStaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol."
|
||||
returns:
|
||||
description: "the condition value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.getWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment.getWorkerSelectors()"
|
||||
name: "getWorkerSelectors()"
|
||||
nameWithType: "ConditionalWorkerSelectorAttachment.getWorkerSelectors()"
|
||||
summary: "Get the worker<wbr>Selectors property: The worker selectors to attach."
|
||||
syntax: "public List<RouterWorkerSelector> getWorkerSelectors()"
|
||||
desc: "Get the workerSelectors property: The worker selectors to attach."
|
||||
returns:
|
||||
description: "the workerSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes a set of worker selectors that will be attached if the given condition resolves to true."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,171 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions"
|
||||
name: "CreateClassificationPolicyOptions"
|
||||
nameWithType: "CreateClassificationPolicyOptions"
|
||||
summary: "Request options for Create Classification<wbr>Policy."
|
||||
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 **CreateClassificationPolicyOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.CreateClassificationPolicyOptions(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.CreateClassificationPolicyOptions(String classificationPolicyId)"
|
||||
name: "CreateClassificationPolicyOptions(String classificationPolicyId)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.CreateClassificationPolicyOptions(String classificationPolicyId)"
|
||||
summary: "Constructor for Create<wbr>Classification<wbr>Policy<wbr>Options"
|
||||
parameters:
|
||||
- description: "ClassificationPolicy id"
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateClassificationPolicyOptions(String classificationPolicyId)"
|
||||
desc: "Constructor for CreateClassificationPolicyOptions"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getClassificationPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getClassificationPolicyId()"
|
||||
name: "getClassificationPolicyId()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getClassificationPolicyId()"
|
||||
summary: "Returns classification policy id."
|
||||
syntax: "public String getClassificationPolicyId()"
|
||||
desc: "Returns classification policy id."
|
||||
returns:
|
||||
description: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getFallbackQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getFallbackQueueId()"
|
||||
name: "getFallbackQueueId()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getFallbackQueueId()"
|
||||
summary: "Returns fallback queue id."
|
||||
syntax: "public String getFallbackQueueId()"
|
||||
desc: "Returns fallback queue id."
|
||||
returns:
|
||||
description: "fallbackQueueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getName()"
|
||||
summary: "Returns classification policy name."
|
||||
syntax: "public String getName()"
|
||||
desc: "Returns classification policy name."
|
||||
returns:
|
||||
description: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getPrioritizationRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getPrioritizationRule()"
|
||||
name: "getPrioritizationRule()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getPrioritizationRule()"
|
||||
summary: "Returns prioritization<wbr>Rule."
|
||||
syntax: "public RouterRule getPrioritizationRule()"
|
||||
desc: "Returns prioritizationRule."
|
||||
returns:
|
||||
description: "prioritizationRule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getQueueSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getQueueSelectors()"
|
||||
name: "getQueueSelectors()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getQueueSelectors()"
|
||||
summary: "Returns list of <xref uid=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueSelectorAttachment\"></xref>s"
|
||||
syntax: "public List<QueueSelectorAttachment> getQueueSelectors()"
|
||||
desc: "Returns list of <xref uid=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueSelectorAttachment\"></xref>s"
|
||||
returns:
|
||||
description: "queueSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.getWorkerSelectors()"
|
||||
name: "getWorkerSelectors()"
|
||||
nameWithType: "CreateClassificationPolicyOptions.getWorkerSelectors()"
|
||||
summary: "Returns list of <xref uid=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WorkerSelectorAttachment\"></xref>s"
|
||||
syntax: "public List<WorkerSelectorAttachment> getWorkerSelectors()"
|
||||
desc: "Returns list of <xref uid=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WorkerSelectorAttachment\"></xref>s"
|
||||
returns:
|
||||
description: "workerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setFallbackQueueId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setFallbackQueueId(String fallbackQueueId)"
|
||||
name: "setFallbackQueueId(String fallbackQueueId)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.setFallbackQueueId(String fallbackQueueId)"
|
||||
summary: "Sets Classification<wbr>Policy fallback<wbr>Queue<wbr>Id."
|
||||
parameters:
|
||||
- description: "CreateClassificationPolicyOptions fallbackQueueId"
|
||||
name: "fallbackQueueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateClassificationPolicyOptions setFallbackQueueId(String fallbackQueueId)"
|
||||
desc: "Sets ClassificationPolicy fallbackQueueId."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.setName(String name)"
|
||||
summary: "Sets Classification<wbr>Policy name."
|
||||
parameters:
|
||||
- description: "CreateClassificationPolicyOptions name"
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateClassificationPolicyOptions setName(String name)"
|
||||
desc: "Sets ClassificationPolicy name."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setPrioritizationRule(com.azure.communication.jobrouter.models.RouterRule)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
name: "setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
summary: "Sets Classification<wbr>Policy prioritization<wbr>Rule."
|
||||
parameters:
|
||||
- description: "CreateClassificationPolicyOptions prioritizationRule"
|
||||
name: "prioritizationRule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateClassificationPolicyOptions setPrioritizationRule(RouterRule prioritizationRule)"
|
||||
desc: "Sets ClassificationPolicy prioritizationRule."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setQueueSelectors(java.util.List<com.azure.communication.jobrouter.models.QueueSelectorAttachment>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setQueueSelectors(List<QueueSelectorAttachment> queueSelectors)"
|
||||
name: "setQueueSelectors(List<QueueSelectorAttachment> queueSelectors)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.setQueueSelectors(List<QueueSelectorAttachment> queueSelectors)"
|
||||
summary: "Sets Classification<wbr>Policy queue<wbr>Selectors."
|
||||
parameters:
|
||||
- description: "CreateClassificationPolicyOptions list of <xref uid=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WorkerSelectorAttachment\"></xref>s"
|
||||
name: "queueSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateClassificationPolicyOptions setQueueSelectors(List<QueueSelectorAttachment> queueSelectors)"
|
||||
desc: "Sets ClassificationPolicy queueSelectors."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setWorkerSelectors(java.util.List<com.azure.communication.jobrouter.models.WorkerSelectorAttachment>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions.setWorkerSelectors(List<WorkerSelectorAttachment> workerSelectors)"
|
||||
name: "setWorkerSelectors(List<WorkerSelectorAttachment> workerSelectors)"
|
||||
nameWithType: "CreateClassificationPolicyOptions.setWorkerSelectors(List<WorkerSelectorAttachment> workerSelectors)"
|
||||
summary: "Sets Classification<wbr>Policy worker<wbr>Selectors."
|
||||
parameters:
|
||||
- description: "CreateClassificationPolicyOptions list of <xref uid=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WorkerSelectorAttachment\"></xref>s"
|
||||
name: "workerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateClassificationPolicyOptions setWorkerSelectors(List<WorkerSelectorAttachment> workerSelectors)"
|
||||
desc: "Sets ClassificationPolicy workerSelectors."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions&text=CreateClassificationPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options for Create ClassificationPolicy. ClassificationPolicy: A container for the rules that govern how jobs are classified."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions"
|
||||
name: "CreateDistributionPolicyOptions"
|
||||
nameWithType: "CreateDistributionPolicyOptions"
|
||||
summary: "Request options to create a Distribution<wbr>Policy."
|
||||
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 **CreateDistributionPolicyOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.CreateDistributionPolicyOptions(java.lang.String,java.time.Duration,com.azure.communication.jobrouter.models.DistributionMode)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.CreateDistributionPolicyOptions(String distributionPolicyId, Duration offerExpiresAfter, DistributionMode mode)"
|
||||
name: "CreateDistributionPolicyOptions(String distributionPolicyId, Duration offerExpiresAfter, DistributionMode mode)"
|
||||
nameWithType: "CreateDistributionPolicyOptions.CreateDistributionPolicyOptions(String distributionPolicyId, Duration offerExpiresAfter, DistributionMode mode)"
|
||||
summary: "Constructor for Create<wbr>Distribution<wbr>Policy<wbr>Options."
|
||||
parameters:
|
||||
- description: "The unique identifier of the policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The expiry time of any offers created under this policy."
|
||||
name: "offerExpiresAfter"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
- description: "Abstract base class for defining a distribution mode."
|
||||
name: "mode"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateDistributionPolicyOptions(String distributionPolicyId, Duration offerExpiresAfter, DistributionMode mode)"
|
||||
desc: "Constructor for CreateDistributionPolicyOptions."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getDistributionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getDistributionPolicyId()"
|
||||
name: "getDistributionPolicyId()"
|
||||
nameWithType: "CreateDistributionPolicyOptions.getDistributionPolicyId()"
|
||||
summary: "Get the unique identifier of the policy."
|
||||
syntax: "public String getDistributionPolicyId()"
|
||||
desc: "Get the unique identifier of the policy."
|
||||
returns:
|
||||
description: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getMode()"
|
||||
name: "getMode()"
|
||||
nameWithType: "CreateDistributionPolicyOptions.getMode()"
|
||||
summary: "Get the distribution mode of this policy."
|
||||
syntax: "public DistributionMode getMode()"
|
||||
desc: "Get the distribution mode of this policy."
|
||||
returns:
|
||||
description: "distributionMode"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "CreateDistributionPolicyOptions.getName()"
|
||||
summary: "Get the human-readable name of the policy."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the human-readable name of the policy."
|
||||
returns:
|
||||
description: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getOfferExpiresAfter()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.getOfferExpiresAfter()"
|
||||
name: "getOfferExpiresAfter()"
|
||||
nameWithType: "CreateDistributionPolicyOptions.getOfferExpiresAfter()"
|
||||
summary: "Get the expiry time for offers created under this policy."
|
||||
syntax: "public Duration getOfferExpiresAfter()"
|
||||
desc: "Get the expiry time for offers created under this policy."
|
||||
returns:
|
||||
description: "offerExpiresAfterSeconds"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "CreateDistributionPolicyOptions.setName(String name)"
|
||||
parameters:
|
||||
- description: "The human-readable name of the policy."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateDistributionPolicyOptions setName(String name)"
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions&text=CreateDistributionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options to create a DistributionPolicy. DistributionPolicy: Policy governing how jobs are distributed to workers."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions"
|
||||
name: "CreateExceptionPolicyOptions"
|
||||
nameWithType: "CreateExceptionPolicyOptions"
|
||||
summary: "Request options for Create Exception<wbr>Policy."
|
||||
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 **CreateExceptionPolicyOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.CreateExceptionPolicyOptions(java.lang.String,java.util.List<com.azure.communication.jobrouter.models.ExceptionRule>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.CreateExceptionPolicyOptions(String exceptionPolicyId, List<ExceptionRule> exceptionRules)"
|
||||
name: "CreateExceptionPolicyOptions(String exceptionPolicyId, List<ExceptionRule> exceptionRules)"
|
||||
nameWithType: "CreateExceptionPolicyOptions.CreateExceptionPolicyOptions(String exceptionPolicyId, List<ExceptionRule> exceptionRules)"
|
||||
summary: "Constructor for Create<wbr>Exception<wbr>Policy<wbr>Options"
|
||||
parameters:
|
||||
- description: "ExceptionPolicy id"
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "Map of exception rules with a string key"
|
||||
name: "exceptionRules"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionRule?alt=com.azure.communication.jobrouter.models.ExceptionRule&text=ExceptionRule\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateExceptionPolicyOptions(String exceptionPolicyId, List<ExceptionRule> exceptionRules)"
|
||||
desc: "Constructor for CreateExceptionPolicyOptions"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getExceptionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getExceptionPolicyId()"
|
||||
name: "getExceptionPolicyId()"
|
||||
nameWithType: "CreateExceptionPolicyOptions.getExceptionPolicyId()"
|
||||
summary: "Returns id of Exception<wbr>Policy."
|
||||
syntax: "public String getExceptionPolicyId()"
|
||||
desc: "Returns id of ExceptionPolicy."
|
||||
returns:
|
||||
description: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getExceptionRules()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getExceptionRules()"
|
||||
name: "getExceptionRules()"
|
||||
nameWithType: "CreateExceptionPolicyOptions.getExceptionRules()"
|
||||
summary: "Returns Exception Rules."
|
||||
syntax: "public List<ExceptionRule> getExceptionRules()"
|
||||
desc: "Returns Exception Rules."
|
||||
returns:
|
||||
description: "exceptionRules."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionRule?alt=com.azure.communication.jobrouter.models.ExceptionRule&text=ExceptionRule\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "CreateExceptionPolicyOptions.getName()"
|
||||
summary: "Returns Exception Policy name."
|
||||
syntax: "public String getName()"
|
||||
desc: "Returns Exception Policy name."
|
||||
returns:
|
||||
description: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "CreateExceptionPolicyOptions.setName(String name)"
|
||||
summary: "Sets Exception<wbr>Policy name."
|
||||
parameters:
|
||||
- description: "ExceptionPolicy name"
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateExceptionPolicyOptions setName(String name)"
|
||||
desc: "Sets ExceptionPolicy name."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions?alt=com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions&text=CreateExceptionPolicyOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options for Create ExceptionPolicy. ExceptionPolicy: A policy that defines actions to execute when exception are triggered."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,269 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions"
|
||||
name: "CreateJobOptions"
|
||||
nameWithType: "CreateJobOptions"
|
||||
summary: "Request options to create a job."
|
||||
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 **CreateJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.CreateJobOptions(java.lang.String,java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.CreateJobOptions(String jobId, String channelId, String queueId)"
|
||||
name: "CreateJobOptions(String jobId, String channelId, String queueId)"
|
||||
nameWithType: "CreateJobOptions.CreateJobOptions(String jobId, String channelId, String queueId)"
|
||||
summary: "Constructor for Create<wbr>Job<wbr>Options."
|
||||
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>"
|
||||
- description: "The channel identifier. eg. voice, chat, etc."
|
||||
name: "channelId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The Id of the Queue that this job is queued to."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateJobOptions(String jobId, String channelId, String queueId)"
|
||||
desc: "Constructor for CreateJobOptions."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getChannelId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getChannelId()"
|
||||
name: "getChannelId()"
|
||||
nameWithType: "CreateJobOptions.getChannelId()"
|
||||
summary: "Returns the channel identifier."
|
||||
syntax: "public String getChannelId()"
|
||||
desc: "Returns the channel identifier. eg. voice, chat, etc."
|
||||
returns:
|
||||
description: "channelId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getChannelReference()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getChannelReference()"
|
||||
name: "getChannelReference()"
|
||||
nameWithType: "CreateJobOptions.getChannelReference()"
|
||||
summary: "Returns the reference to an external parent context, eg."
|
||||
syntax: "public String getChannelReference()"
|
||||
desc: "Returns the reference to an external parent context, eg. call ID."
|
||||
returns:
|
||||
description: "channelReference"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getDispositionCode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getDispositionCode()"
|
||||
name: "getDispositionCode()"
|
||||
nameWithType: "CreateJobOptions.getDispositionCode()"
|
||||
summary: "Returns the reason code for cancelled or closed jobs."
|
||||
syntax: "public String getDispositionCode()"
|
||||
desc: "Returns the reason code for cancelled or closed jobs."
|
||||
returns:
|
||||
description: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "CreateJobOptions.getJobId()"
|
||||
summary: "Returns the id of Router<wbr>Job."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Returns the id of RouterJob."
|
||||
returns:
|
||||
description: "id."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "CreateJobOptions.getLabels()"
|
||||
summary: "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getMatchingMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getMatchingMode()"
|
||||
name: "getMatchingMode()"
|
||||
nameWithType: "CreateJobOptions.getMatchingMode()"
|
||||
summary: "Get the matching<wbr>Mode property: The matching<wbr>Mode property."
|
||||
syntax: "public JobMatchingMode getMatchingMode()"
|
||||
desc: "Get the matchingMode property: The matchingMode property."
|
||||
returns:
|
||||
description: "the matchingMode value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getNotes()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getNotes()"
|
||||
name: "getNotes()"
|
||||
nameWithType: "CreateJobOptions.getNotes()"
|
||||
summary: "Notes attached to a job, sorted by timestamp"
|
||||
syntax: "public List<RouterJobNote> getNotes()"
|
||||
desc: "Notes attached to a job, sorted by timestamp"
|
||||
returns:
|
||||
description: "note"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobNote?alt=com.azure.communication.jobrouter.models.RouterJobNote&text=RouterJobNote\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getPriority()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getPriority()"
|
||||
name: "getPriority()"
|
||||
nameWithType: "CreateJobOptions.getPriority()"
|
||||
summary: "Returns the priority of this job."
|
||||
syntax: "public Integer getPriority()"
|
||||
desc: "Returns the priority of this job."
|
||||
returns:
|
||||
description: "priority"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "CreateJobOptions.getQueueId()"
|
||||
summary: "Returns the Id of the Queue that this job is queued to."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Returns the Id of the Queue that this job is queued to."
|
||||
returns:
|
||||
description: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getRequestedWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getRequestedWorkerSelectors()"
|
||||
name: "getRequestedWorkerSelectors()"
|
||||
nameWithType: "CreateJobOptions.getRequestedWorkerSelectors()"
|
||||
summary: "Returns the collection of manually specified label selectors that a worker must satisfy in order to process a job."
|
||||
syntax: "public List<RouterWorkerSelector> getRequestedWorkerSelectors()"
|
||||
desc: "Returns the collection of manually specified label selectors that a worker must satisfy in order to process a job."
|
||||
returns:
|
||||
description: "requestedWorkerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.getTags()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "CreateJobOptions.getTags()"
|
||||
summary: "A set of non-identifying attributes attached to this job"
|
||||
syntax: "public Map<String,RouterValue> getTags()"
|
||||
desc: "A set of non-identifying attributes attached to this job"
|
||||
returns:
|
||||
description: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setChannelReference(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setChannelReference(String channelReference)"
|
||||
name: "setChannelReference(String channelReference)"
|
||||
nameWithType: "CreateJobOptions.setChannelReference(String channelReference)"
|
||||
summary: "Sets channel<wbr>Reference."
|
||||
parameters:
|
||||
- description: "Reference to an external parent context, eg. call ID."
|
||||
name: "channelReference"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateJobOptions setChannelReference(String channelReference)"
|
||||
desc: "Sets channelReference."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setDispositionCode(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setDispositionCode(String dispositionCode)"
|
||||
name: "setDispositionCode(String dispositionCode)"
|
||||
nameWithType: "CreateJobOptions.setDispositionCode(String dispositionCode)"
|
||||
summary: "Sets disposition<wbr>Code."
|
||||
parameters:
|
||||
- description: "Reason code for cancelled or closed jobs."
|
||||
name: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateJobOptions setDispositionCode(String dispositionCode)"
|
||||
desc: "Sets dispositionCode."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "CreateJobOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Sets labels."
|
||||
parameters:
|
||||
- description: "A set of key/value pairs that are identifying attributes used by the\n rules engines to make decisions."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateJobOptions setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Sets labels."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setMatchingMode(com.azure.communication.jobrouter.models.JobMatchingMode)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setMatchingMode(JobMatchingMode matchingMode)"
|
||||
name: "setMatchingMode(JobMatchingMode matchingMode)"
|
||||
nameWithType: "CreateJobOptions.setMatchingMode(JobMatchingMode matchingMode)"
|
||||
summary: "Set the matching<wbr>Mode property: The matching<wbr>Mode property."
|
||||
parameters:
|
||||
- description: "the matchingMode value to set."
|
||||
name: "matchingMode"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public CreateJobOptions setMatchingMode(JobMatchingMode matchingMode)"
|
||||
desc: "Set the matchingMode property: The matchingMode property."
|
||||
returns:
|
||||
description: "the RouterJobInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setNotes(java.util.List<com.azure.communication.jobrouter.models.RouterJobNote>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setNotes(List<RouterJobNote> notes)"
|
||||
name: "setNotes(List<RouterJobNote> notes)"
|
||||
nameWithType: "CreateJobOptions.setNotes(List<RouterJobNote> notes)"
|
||||
summary: "Sets notes."
|
||||
parameters:
|
||||
- description: "Notes attached to a job, sorted by timestamp."
|
||||
name: "notes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobNote?alt=com.azure.communication.jobrouter.models.RouterJobNote&text=RouterJobNote\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateJobOptions setNotes(List<RouterJobNote> notes)"
|
||||
desc: "Sets notes."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setPriority(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setPriority(Integer priority)"
|
||||
name: "setPriority(Integer priority)"
|
||||
nameWithType: "CreateJobOptions.setPriority(Integer priority)"
|
||||
summary: "Sets job priority."
|
||||
parameters:
|
||||
- description: "The priority of this job."
|
||||
name: "priority"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public CreateJobOptions setPriority(Integer priority)"
|
||||
desc: "Sets job priority."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setRequestedWorkerSelectors(java.util.List<com.azure.communication.jobrouter.models.RouterWorkerSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
name: "setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
nameWithType: "CreateJobOptions.setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
summary: "Sets requested<wbr>Worker<wbr>Selectors."
|
||||
parameters:
|
||||
- description: "A collection of manually specified label selectors, which a worker must\n satisfy in order to process this job."
|
||||
name: "requestedWorkerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateJobOptions setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
desc: "Sets requestedWorkerSelectors."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateJobOptions.setTags(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateJobOptions.setTags(Map<String,RouterValue> tags)"
|
||||
name: "setTags(Map<String,RouterValue> tags)"
|
||||
nameWithType: "CreateJobOptions.setTags(Map<String,RouterValue> tags)"
|
||||
summary: "Sets tags."
|
||||
parameters:
|
||||
- description: "A set of non-identifying attributes attached to this job."
|
||||
name: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateJobOptions setTags(Map<String,RouterValue> tags)"
|
||||
desc: "Sets tags."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateJobOptions?alt=com.azure.communication.jobrouter.models.CreateJobOptions&text=CreateJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options to create a job. Job: A unit of work to be routed."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,136 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateQueueOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions"
|
||||
name: "CreateQueueOptions"
|
||||
nameWithType: "CreateQueueOptions"
|
||||
summary: "Request options to create a queue."
|
||||
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 **CreateQueueOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.CreateQueueOptions(java.lang.String,java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.CreateQueueOptions(String queueId, String distributionPolicyId)"
|
||||
name: "CreateQueueOptions(String queueId, String distributionPolicyId)"
|
||||
nameWithType: "CreateQueueOptions.CreateQueueOptions(String queueId, String distributionPolicyId)"
|
||||
summary: "Constructor for Create<wbr>Queue<wbr>Options."
|
||||
parameters:
|
||||
- description: "The id of queue."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The id of distribution policy."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateQueueOptions(String queueId, String distributionPolicyId)"
|
||||
desc: "Constructor for CreateQueueOptions."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.getDistributionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.getDistributionPolicyId()"
|
||||
name: "getDistributionPolicyId()"
|
||||
nameWithType: "CreateQueueOptions.getDistributionPolicyId()"
|
||||
summary: "Returns the id of distribution policy."
|
||||
syntax: "public String getDistributionPolicyId()"
|
||||
desc: "Returns the id of distribution policy."
|
||||
returns:
|
||||
description: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.getExceptionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.getExceptionPolicyId()"
|
||||
name: "getExceptionPolicyId()"
|
||||
nameWithType: "CreateQueueOptions.getExceptionPolicyId()"
|
||||
summary: "Returns the id of exception policy."
|
||||
syntax: "public String getExceptionPolicyId()"
|
||||
desc: "Returns the id of exception policy."
|
||||
returns:
|
||||
description: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "CreateQueueOptions.getLabels()"
|
||||
summary: "Returns labels of Queue."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "Returns labels of Queue."
|
||||
returns:
|
||||
description: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "CreateQueueOptions.getName()"
|
||||
summary: "Returns the name of this queue."
|
||||
syntax: "public String getName()"
|
||||
desc: "Returns the name of this queue."
|
||||
returns:
|
||||
description: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "CreateQueueOptions.getQueueId()"
|
||||
summary: "Returns the id of Job Queue."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Returns the id of Job Queue."
|
||||
returns:
|
||||
description: "id."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.setExceptionPolicyId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.setExceptionPolicyId(String exceptionPolicyId)"
|
||||
name: "setExceptionPolicyId(String exceptionPolicyId)"
|
||||
nameWithType: "CreateQueueOptions.setExceptionPolicyId(String exceptionPolicyId)"
|
||||
summary: "Sets exception<wbr>Policy<wbr>Id"
|
||||
parameters:
|
||||
- description: "(Optional) The ID of the exception policy that determines various job escalation rules."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateQueueOptions setExceptionPolicyId(String exceptionPolicyId)"
|
||||
desc: "Sets exceptionPolicyId"
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "CreateQueueOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Sets labels"
|
||||
parameters:
|
||||
- description: "A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateQueueOptions setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Sets labels"
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateQueueOptions.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateQueueOptions.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "CreateQueueOptions.setName(String name)"
|
||||
summary: "Sets name"
|
||||
parameters:
|
||||
- description: "Human-readable name of queue."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public CreateQueueOptions setName(String name)"
|
||||
desc: "Sets name"
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateQueueOptions?alt=com.azure.communication.jobrouter.models.CreateQueueOptions&text=CreateQueueOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options to create a queue. Queue: A queue that can contain jobs to be routed."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,184 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions"
|
||||
name: "CreateWorkerOptions"
|
||||
nameWithType: "CreateWorkerOptions"
|
||||
summary: "Request options to create a worker."
|
||||
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 **CreateWorkerOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.CreateWorkerOptions(java.lang.String,java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.CreateWorkerOptions(String workerId, Integer capacity)"
|
||||
name: "CreateWorkerOptions(String workerId, Integer capacity)"
|
||||
nameWithType: "CreateWorkerOptions.CreateWorkerOptions(String workerId, Integer capacity)"
|
||||
summary: "Constructor for Create<wbr>Worker<wbr>Options."
|
||||
parameters:
|
||||
- description: "The id property."
|
||||
name: "workerId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "The total capacity score this worker has to manage multiple concurrent jobs."
|
||||
name: "capacity"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public CreateWorkerOptions(String workerId, Integer capacity)"
|
||||
desc: "Constructor for CreateWorkerOptions."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getCapacity()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getCapacity()"
|
||||
name: "getCapacity()"
|
||||
nameWithType: "CreateWorkerOptions.getCapacity()"
|
||||
summary: "Returns capacity."
|
||||
syntax: "public Integer getCapacity()"
|
||||
desc: "Returns capacity."
|
||||
returns:
|
||||
description: "capacity"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getChannels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getChannels()"
|
||||
name: "getChannels()"
|
||||
nameWithType: "CreateWorkerOptions.getChannels()"
|
||||
summary: "Returns channels."
|
||||
syntax: "public List<RouterChannel> getChannels()"
|
||||
desc: "Returns channels."
|
||||
returns:
|
||||
description: "channels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterChannel?alt=com.azure.communication.jobrouter.models.RouterChannel&text=RouterChannel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "CreateWorkerOptions.getLabels()"
|
||||
summary: "Returns labels."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "Returns labels."
|
||||
returns:
|
||||
description: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getQueues()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getQueues()"
|
||||
name: "getQueues()"
|
||||
nameWithType: "CreateWorkerOptions.getQueues()"
|
||||
summary: "Returns queues."
|
||||
syntax: "public List<String> getQueues()"
|
||||
desc: "Returns queues."
|
||||
returns:
|
||||
description: "queues."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getTags()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "CreateWorkerOptions.getTags()"
|
||||
summary: "Returns tags."
|
||||
syntax: "public Map<String,RouterValue> getTags()"
|
||||
desc: "Returns tags."
|
||||
returns:
|
||||
description: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getWorkerId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.getWorkerId()"
|
||||
name: "getWorkerId()"
|
||||
nameWithType: "CreateWorkerOptions.getWorkerId()"
|
||||
summary: "Returns id."
|
||||
syntax: "public String getWorkerId()"
|
||||
desc: "Returns id."
|
||||
returns:
|
||||
description: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.isAvailableForOffers()"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.isAvailableForOffers()"
|
||||
name: "isAvailableForOffers()"
|
||||
nameWithType: "CreateWorkerOptions.isAvailableForOffers()"
|
||||
summary: "Returns available<wbr>For<wbr>Offers."
|
||||
syntax: "public Boolean isAvailableForOffers()"
|
||||
desc: "Returns availableForOffers."
|
||||
returns:
|
||||
description: "availableForOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setAvailableForOffers(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setAvailableForOffers(Boolean availableForOffers)"
|
||||
name: "setAvailableForOffers(Boolean availableForOffers)"
|
||||
nameWithType: "CreateWorkerOptions.setAvailableForOffers(Boolean availableForOffers)"
|
||||
summary: "Set the available<wbr>For<wbr>Offers property: A flag indicating this worker is open to receive offers or not."
|
||||
parameters:
|
||||
- description: "the availableForOffers value to set."
|
||||
name: "availableForOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public CreateWorkerOptions setAvailableForOffers(Boolean availableForOffers)"
|
||||
desc: "Set the availableForOffers property: A flag indicating this worker is open to receive offers or not."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setChannels(java.util.List<com.azure.communication.jobrouter.models.RouterChannel>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setChannels(List<RouterChannel> channels)"
|
||||
name: "setChannels(List<RouterChannel> channels)"
|
||||
nameWithType: "CreateWorkerOptions.setChannels(List<RouterChannel> channels)"
|
||||
summary: "Set the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
parameters:
|
||||
- description: "the channels value to set."
|
||||
name: "channels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterChannel?alt=com.azure.communication.jobrouter.models.RouterChannel&text=RouterChannel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateWorkerOptions setChannels(List<RouterChannel> channels)"
|
||||
desc: "Set the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "CreateWorkerOptions.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
parameters:
|
||||
- description: "the labels value to set."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateWorkerOptions setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setQueues(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setQueues(List<String> queues)"
|
||||
name: "setQueues(List<String> queues)"
|
||||
nameWithType: "CreateWorkerOptions.setQueues(List<String> queues)"
|
||||
summary: "Set the queues property: The queue(s) that this worker can receive work from."
|
||||
parameters:
|
||||
- description: "the queues value to set."
|
||||
name: "queues"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public CreateWorkerOptions setQueues(List<String> queues)"
|
||||
desc: "Set the queues property: The queue(s) that this worker can receive work from."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setTags(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.CreateWorkerOptions.setTags(Map<String,RouterValue> tags)"
|
||||
name: "setTags(Map<String,RouterValue> tags)"
|
||||
nameWithType: "CreateWorkerOptions.setTags(Map<String,RouterValue> tags)"
|
||||
summary: "Set the tags property: A set of non-identifying attributes attached to this worker."
|
||||
parameters:
|
||||
- description: "the tags value to set."
|
||||
name: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public CreateWorkerOptions setTags(Map<String,RouterValue> tags)"
|
||||
desc: "Set the tags property: A set of non-identifying attributes attached to this worker."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.CreateWorkerOptions?alt=com.azure.communication.jobrouter.models.CreateWorkerOptions&text=CreateWorkerOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request options to create a worker. Worker: An entity for jobs to be routed to."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions"
|
||||
name: "DeclineJobOfferOptions"
|
||||
nameWithType: "DeclineJobOfferOptions"
|
||||
summary: "Request payload for declining offers."
|
||||
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 **DeclineJobOfferOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.DeclineJobOfferOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.DeclineJobOfferOptions()"
|
||||
name: "DeclineJobOfferOptions()"
|
||||
nameWithType: "DeclineJobOfferOptions.DeclineJobOfferOptions()"
|
||||
summary: "Creates an instance of Decline<wbr>Job<wbr>Offer<wbr>Options<wbr>Internal class."
|
||||
syntax: "public DeclineJobOfferOptions()"
|
||||
desc: "Creates an instance of DeclineJobOfferOptionsInternal class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.getRetryOfferAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.getRetryOfferAt()"
|
||||
name: "getRetryOfferAt()"
|
||||
nameWithType: "DeclineJobOfferOptions.getRetryOfferAt()"
|
||||
summary: "Get the retry<wbr>Offer<wbr>At property: If the Retry<wbr>Offer<wbr>At is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered."
|
||||
syntax: "public OffsetDateTime getRetryOfferAt()"
|
||||
desc: "Get the retryOfferAt property: If the RetryOfferAt is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered. If a RetryOfferAt time is provided, then the job will be re-matched to eligible workers at the retry time in UTC. The worker that declined the job will also be eligible for the job at that time."
|
||||
returns:
|
||||
description: "the retryOfferAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.setRetryOfferAt(java.time.OffsetDateTime)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DeclineJobOfferOptions.setRetryOfferAt(OffsetDateTime retryOfferAt)"
|
||||
name: "setRetryOfferAt(OffsetDateTime retryOfferAt)"
|
||||
nameWithType: "DeclineJobOfferOptions.setRetryOfferAt(OffsetDateTime retryOfferAt)"
|
||||
summary: "Set the retry<wbr>Offer<wbr>At property: If the Retry<wbr>Offer<wbr>At is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered."
|
||||
parameters:
|
||||
- description: "the retryOfferAt value to set."
|
||||
name: "retryOfferAt"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
syntax: "public DeclineJobOfferOptions setRetryOfferAt(OffsetDateTime retryOfferAt)"
|
||||
desc: "Set the retryOfferAt property: If the RetryOfferAt is not provided, then this job will not be offered again to the worker who declined this job unless the worker is de-registered and re-registered. If a RetryOfferAt time is provided, then the job will be re-matched to eligible workers at the retry time in UTC. The worker that declined the job will also be eligible for the job at that time."
|
||||
returns:
|
||||
description: "the DeclineJobOfferOptionsInternal object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DeclineJobOfferOptions?alt=com.azure.communication.jobrouter.models.DeclineJobOfferOptions&text=DeclineJobOfferOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request payload for declining offers."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.DirectMapRouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.DirectMapRouterRule"
|
||||
name: "DirectMapRouterRule"
|
||||
nameWithType: "DirectMapRouterRule"
|
||||
summary: "A rule that return the same labels as the input labels."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule.getKind()?alt=com.azure.communication.jobrouter.models.RouterRule.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **DirectMapRouterRule**</br> extends <xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.DirectMapRouterRule.DirectMapRouterRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DirectMapRouterRule.DirectMapRouterRule()"
|
||||
name: "DirectMapRouterRule()"
|
||||
nameWithType: "DirectMapRouterRule.DirectMapRouterRule()"
|
||||
summary: "Creates an instance of Direct<wbr>Map<wbr>Router<wbr>Rule class."
|
||||
syntax: "public DirectMapRouterRule()"
|
||||
desc: "Creates an instance of DirectMapRouterRule class."
|
||||
type: "class"
|
||||
desc: "A rule that return the same labels as the input labels."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.DistributionMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode"
|
||||
name: "DistributionMode"
|
||||
nameWithType: "DistributionMode"
|
||||
summary: "Abstract base class for defining a distribution mode."
|
||||
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 abstract class **DistributionMode**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.DistributionMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.DistributionMode()"
|
||||
name: "DistributionMode()"
|
||||
nameWithType: "DistributionMode.DistributionMode()"
|
||||
summary: "Creates an instance of Distribution<wbr>Mode class."
|
||||
syntax: "public DistributionMode()"
|
||||
desc: "Creates an instance of DistributionMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "DistributionMode.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers()"
|
||||
name: "getMaxConcurrentOffers()"
|
||||
nameWithType: "DistributionMode.getMaxConcurrentOffers()"
|
||||
summary: "Get the max<wbr>Concurrent<wbr>Offers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
syntax: "public Integer getMaxConcurrentOffers()"
|
||||
desc: "Get the maxConcurrentOffers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
returns:
|
||||
description: "the maxConcurrentOffers value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers()"
|
||||
name: "getMinConcurrentOffers()"
|
||||
nameWithType: "DistributionMode.getMinConcurrentOffers()"
|
||||
summary: "Get the min<wbr>Concurrent<wbr>Offers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
syntax: "public Integer getMinConcurrentOffers()"
|
||||
desc: "Get the minConcurrentOffers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
returns:
|
||||
description: "the minConcurrentOffers value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors()"
|
||||
name: "isBypassSelectors()"
|
||||
nameWithType: "DistributionMode.isBypassSelectors()"
|
||||
summary: "Get the bypass<wbr>Selectors property: If set to true, then router will match workers to jobs even if they don't match label selectors."
|
||||
syntax: "public Boolean isBypassSelectors()"
|
||||
desc: "Get the bypassSelectors property: If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false."
|
||||
returns:
|
||||
description: "the bypassSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
name: "setBypassSelectors(Boolean bypassSelectors)"
|
||||
nameWithType: "DistributionMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
summary: "Set the bypass<wbr>Selectors property: If set to true, then router will match workers to jobs even if they don't match label selectors."
|
||||
parameters:
|
||||
- description: "the bypassSelectors value to set."
|
||||
name: "bypassSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public DistributionMode setBypassSelectors(Boolean bypassSelectors)"
|
||||
desc: "Set the bypassSelectors property: If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false."
|
||||
returns:
|
||||
description: "the DistributionMode object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
name: "setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
nameWithType: "DistributionMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
summary: "Set the max<wbr>Concurrent<wbr>Offers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
parameters:
|
||||
- description: "the maxConcurrentOffers value to set."
|
||||
name: "maxConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public DistributionMode setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
desc: "Set the maxConcurrentOffers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
returns:
|
||||
description: "the DistributionMode object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
name: "setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
nameWithType: "DistributionMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
summary: "Set the min<wbr>Concurrent<wbr>Offers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
parameters:
|
||||
- description: "the minConcurrentOffers value to set."
|
||||
name: "minConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public DistributionMode setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
desc: "Set the minConcurrentOffers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
returns:
|
||||
description: "the DistributionMode object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Abstract base class for defining a distribution mode."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.DistributionPolicy"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy"
|
||||
name: "DistributionPolicy"
|
||||
nameWithType: "DistributionPolicy"
|
||||
summary: "Policy governing how jobs are distributed to workers."
|
||||
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 **DistributionPolicy**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.DistributionPolicy()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.DistributionPolicy()"
|
||||
name: "DistributionPolicy()"
|
||||
nameWithType: "DistributionPolicy.DistributionPolicy()"
|
||||
summary: "Creates an instance of Distribution<wbr>Policy class."
|
||||
syntax: "public DistributionPolicy()"
|
||||
desc: "Creates an instance of DistributionPolicy class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "DistributionPolicy.getEtag()"
|
||||
summary: "Get the etag property: Concurrency Token."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: Concurrency Token."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "DistributionPolicy.getId()"
|
||||
summary: "Get the id property: The unique identifier of the policy."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The unique identifier of the policy."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.getMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.getMode()"
|
||||
name: "getMode()"
|
||||
nameWithType: "DistributionPolicy.getMode()"
|
||||
summary: "Get the mode property: Abstract base class for defining a distribution mode."
|
||||
syntax: "public DistributionMode getMode()"
|
||||
desc: "Get the mode property: Abstract base class for defining a distribution mode."
|
||||
returns:
|
||||
description: "the mode value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "DistributionPolicy.getName()"
|
||||
summary: "Get the name property: The human readable name of the policy."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: The human readable name of the policy."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.getOfferExpiresAfter()"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.getOfferExpiresAfter()"
|
||||
name: "getOfferExpiresAfter()"
|
||||
nameWithType: "DistributionPolicy.getOfferExpiresAfter()"
|
||||
summary: "Get the offer<wbr>Expires<wbr>After property: The duration after which any offers created under this policy will be expired."
|
||||
syntax: "public Duration getOfferExpiresAfter()"
|
||||
desc: "Get the offerExpiresAfter property: The duration after which any offers created under this policy will be expired."
|
||||
returns:
|
||||
description: "the offerExpiresAfter value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.setMode(com.azure.communication.jobrouter.models.DistributionMode)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.setMode(DistributionMode mode)"
|
||||
name: "setMode(DistributionMode mode)"
|
||||
nameWithType: "DistributionPolicy.setMode(DistributionMode mode)"
|
||||
summary: "Set the mode property: Abstract base class for defining a distribution mode."
|
||||
parameters:
|
||||
- description: "the mode value to set."
|
||||
name: "mode"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public DistributionPolicy setMode(DistributionMode mode)"
|
||||
desc: "Set the mode property: Abstract base class for defining a distribution mode."
|
||||
returns:
|
||||
description: "the DistributionPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "DistributionPolicy.setName(String name)"
|
||||
summary: "Set the name property: The human readable name of the policy."
|
||||
parameters:
|
||||
- description: "the name value to set."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public DistributionPolicy setName(String name)"
|
||||
desc: "Set the name property: The human readable name of the policy."
|
||||
returns:
|
||||
description: "the DistributionPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.DistributionPolicy.setOfferExpiresAfter(java.time.Duration)"
|
||||
fullName: "com.azure.communication.jobrouter.models.DistributionPolicy.setOfferExpiresAfter(Duration offerExpiresAfter)"
|
||||
name: "setOfferExpiresAfter(Duration offerExpiresAfter)"
|
||||
nameWithType: "DistributionPolicy.setOfferExpiresAfter(Duration offerExpiresAfter)"
|
||||
summary: "Set the offer<wbr>Expires<wbr>After property: The duration after which any offers created under this policy will be expired."
|
||||
parameters:
|
||||
- description: "the offerExpiresAfter value to set."
|
||||
name: "offerExpiresAfter"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
syntax: "public DistributionPolicy setOfferExpiresAfter(Duration offerExpiresAfter)"
|
||||
desc: "Set the offerExpiresAfter property: The duration after which any offers created under this policy will be expired."
|
||||
returns:
|
||||
description: "the DistributionPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.DistributionPolicy?alt=com.azure.communication.jobrouter.models.DistributionPolicy&text=DistributionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Policy governing how jobs are distributed to workers."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExceptionAction"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionAction"
|
||||
name: "ExceptionAction"
|
||||
nameWithType: "ExceptionAction"
|
||||
summary: "The action to take when the exception is triggered."
|
||||
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 abstract class **ExceptionAction**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionAction.ExceptionAction()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionAction.ExceptionAction()"
|
||||
name: "ExceptionAction()"
|
||||
nameWithType: "ExceptionAction.ExceptionAction()"
|
||||
summary: "Creates an instance of Exception<wbr>Action class."
|
||||
syntax: "public ExceptionAction()"
|
||||
desc: "Creates an instance of ExceptionAction class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionAction.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionAction.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "ExceptionAction.getId()"
|
||||
summary: "Get the id property: Unique Id of the exception action."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: Unique Id of the exception action."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionAction.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionAction.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "ExceptionAction.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "The action to take when the exception is triggered."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExceptionPolicy"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy"
|
||||
name: "ExceptionPolicy"
|
||||
nameWithType: "ExceptionPolicy"
|
||||
summary: "A policy that defines actions to execute when exception are triggered."
|
||||
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 **ExceptionPolicy**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.ExceptionPolicy()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.ExceptionPolicy()"
|
||||
name: "ExceptionPolicy()"
|
||||
nameWithType: "ExceptionPolicy.ExceptionPolicy()"
|
||||
summary: "Creates an instance of Exception<wbr>Policy class."
|
||||
syntax: "public ExceptionPolicy()"
|
||||
desc: "Creates an instance of ExceptionPolicy class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "ExceptionPolicy.getEtag()"
|
||||
summary: "Get the etag property: The entity tag for this resource."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: The entity tag for this resource."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.getExceptionRules()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.getExceptionRules()"
|
||||
name: "getExceptionRules()"
|
||||
nameWithType: "ExceptionPolicy.getExceptionRules()"
|
||||
summary: "Get the exception<wbr>Rules property: A collection of exception rules on the exception policy."
|
||||
syntax: "public List<ExceptionRule> getExceptionRules()"
|
||||
desc: "Get the exceptionRules property: A collection of exception rules on the exception policy."
|
||||
returns:
|
||||
description: "the exceptionRules value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionRule?alt=com.azure.communication.jobrouter.models.ExceptionRule&text=ExceptionRule\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "ExceptionPolicy.getId()"
|
||||
summary: "Get the id property: The Id of the exception policy."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The Id of the exception policy."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "ExceptionPolicy.getName()"
|
||||
summary: "Get the name property: The name of the exception policy."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: The name of the exception policy."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.setExceptionRules(java.util.List<com.azure.communication.jobrouter.models.ExceptionRule>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.setExceptionRules(List<ExceptionRule> exceptionRules)"
|
||||
name: "setExceptionRules(List<ExceptionRule> exceptionRules)"
|
||||
nameWithType: "ExceptionPolicy.setExceptionRules(List<ExceptionRule> exceptionRules)"
|
||||
summary: "Set the exception<wbr>Rules property: A collection of exception rules on the exception policy."
|
||||
parameters:
|
||||
- description: "the exceptionRules value to set."
|
||||
name: "exceptionRules"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionRule?alt=com.azure.communication.jobrouter.models.ExceptionRule&text=ExceptionRule\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ExceptionPolicy setExceptionRules(List<ExceptionRule> exceptionRules)"
|
||||
desc: "Set the exceptionRules property: A collection of exception rules on the exception policy."
|
||||
returns:
|
||||
description: "the ExceptionPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionPolicy.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionPolicy.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "ExceptionPolicy.setName(String name)"
|
||||
summary: "Set the name property: The name of the exception policy."
|
||||
parameters:
|
||||
- description: "the name value to set."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ExceptionPolicy setName(String name)"
|
||||
desc: "Set the name property: The name of the exception policy."
|
||||
returns:
|
||||
description: "the ExceptionPolicy object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionPolicy?alt=com.azure.communication.jobrouter.models.ExceptionPolicy&text=ExceptionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A policy that defines actions to execute when exception are triggered."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExceptionRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionRule"
|
||||
name: "ExceptionRule"
|
||||
nameWithType: "ExceptionRule"
|
||||
summary: "A rule that defines actions to execute upon a specific trigger."
|
||||
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 **ExceptionRule**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionRule.ExceptionRule(java.lang.String,com.azure.communication.jobrouter.models.ExceptionTrigger,java.util.List<com.azure.communication.jobrouter.models.ExceptionAction>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionRule.ExceptionRule(String id, ExceptionTrigger trigger, List<ExceptionAction> actions)"
|
||||
name: "ExceptionRule(String id, ExceptionTrigger trigger, List<ExceptionAction> actions)"
|
||||
nameWithType: "ExceptionRule.ExceptionRule(String id, ExceptionTrigger trigger, List<ExceptionAction> actions)"
|
||||
summary: "Creates an instance of Exception<wbr>Rule class."
|
||||
parameters:
|
||||
- description: "the id value to set."
|
||||
name: "id"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the trigger value to set."
|
||||
name: "trigger"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the actions value to set."
|
||||
name: "actions"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ExceptionRule(String id, ExceptionTrigger trigger, List<ExceptionAction> actions)"
|
||||
desc: "Creates an instance of ExceptionRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionRule.getActions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionRule.getActions()"
|
||||
name: "getActions()"
|
||||
nameWithType: "ExceptionRule.getActions()"
|
||||
summary: "Get the actions property: A collection of actions to perform once the exception is triggered."
|
||||
syntax: "public List<ExceptionAction> getActions()"
|
||||
desc: "Get the actions property: A collection of actions to perform once the exception is triggered."
|
||||
returns:
|
||||
description: "the actions value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionRule.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionRule.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "ExceptionRule.getId()"
|
||||
summary: "Get the id property: Id of the exception rule."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: Id of the exception rule."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionRule.getTrigger()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionRule.getTrigger()"
|
||||
name: "getTrigger()"
|
||||
nameWithType: "ExceptionRule.getTrigger()"
|
||||
summary: "Get the trigger property: The trigger for this exception rule."
|
||||
syntax: "public ExceptionTrigger getTrigger()"
|
||||
desc: "Get the trigger property: The trigger for this exception rule."
|
||||
returns:
|
||||
description: "the trigger value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rule that defines actions to execute upon a specific trigger."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExceptionTrigger"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionTrigger"
|
||||
name: "ExceptionTrigger"
|
||||
nameWithType: "ExceptionTrigger"
|
||||
summary: "The trigger for this exception rule."
|
||||
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 abstract class **ExceptionTrigger**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionTrigger.ExceptionTrigger()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionTrigger.ExceptionTrigger()"
|
||||
name: "ExceptionTrigger()"
|
||||
nameWithType: "ExceptionTrigger.ExceptionTrigger()"
|
||||
summary: "Creates an instance of Exception<wbr>Trigger class."
|
||||
syntax: "public ExceptionTrigger()"
|
||||
desc: "Creates an instance of ExceptionTrigger class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExceptionTrigger.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExceptionTrigger.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "ExceptionTrigger.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "The trigger for this exception rule."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExpressionRouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRule"
|
||||
name: "ExpressionRouterRule"
|
||||
nameWithType: "ExpressionRouterRule"
|
||||
summary: "A rule providing inline expression rules."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule.getKind()?alt=com.azure.communication.jobrouter.models.RouterRule.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ExpressionRouterRule**</br> extends <xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRule.ExpressionRouterRule(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRule.ExpressionRouterRule(String expression)"
|
||||
name: "ExpressionRouterRule(String expression)"
|
||||
nameWithType: "ExpressionRouterRule.ExpressionRouterRule(String expression)"
|
||||
summary: "Creates an instance of Expression<wbr>Router<wbr>Rule class."
|
||||
parameters:
|
||||
- description: "the expression value to set."
|
||||
name: "expression"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ExpressionRouterRule(String expression)"
|
||||
desc: "Creates an instance of ExpressionRouterRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRule.getExpression()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRule.getExpression()"
|
||||
name: "getExpression()"
|
||||
nameWithType: "ExpressionRouterRule.getExpression()"
|
||||
summary: "Get the expression property: The string containing the expression to evaluate."
|
||||
syntax: "public String getExpression()"
|
||||
desc: "Get the expression property: The string containing the expression to evaluate. Should contain return statement with calculated values."
|
||||
returns:
|
||||
description: "the expression value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRule.getLanguage()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRule.getLanguage()"
|
||||
name: "getLanguage()"
|
||||
nameWithType: "ExpressionRouterRule.getLanguage()"
|
||||
summary: "Get the language property: The expression language to compile to and execute."
|
||||
syntax: "public ExpressionRouterRuleLanguage getLanguage()"
|
||||
desc: "Get the language property: The expression language to compile to and execute."
|
||||
returns:
|
||||
description: "the language value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage?alt=com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage&text=ExpressionRouterRuleLanguage\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rule providing inline expression rules."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage"
|
||||
name: "ExpressionRouterRuleLanguage"
|
||||
nameWithType: "ExpressionRouterRuleLanguage"
|
||||
summary: "Available expression languages that can be configured."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **ExpressionRouterRuleLanguage**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage?alt=com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage&text=ExpressionRouterRuleLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.ExpressionRouterRuleLanguage()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.ExpressionRouterRuleLanguage()"
|
||||
name: "ExpressionRouterRuleLanguage()"
|
||||
nameWithType: "ExpressionRouterRuleLanguage.ExpressionRouterRuleLanguage()"
|
||||
summary: "Creates a new instance of Expression<wbr>Router<wbr>Rule<wbr>Language value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ExpressionRouterRuleLanguage()"
|
||||
desc: "Creates a new instance of ExpressionRouterRuleLanguage value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.POWER_FX"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.POWER_FX"
|
||||
name: "POWER_FX"
|
||||
nameWithType: "ExpressionRouterRuleLanguage.POWER_FX"
|
||||
summary: "Power<wbr>Fx."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage?alt=com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage&text=ExpressionRouterRuleLanguage\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ExpressionRouterRuleLanguage POWER_FX"
|
||||
desc: "PowerFx."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "ExpressionRouterRuleLanguage.fromString(String name)"
|
||||
summary: "Creates or finds a Expression<wbr>Router<wbr>Rule<wbr>Language from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ExpressionRouterRuleLanguage fromString(String name)"
|
||||
desc: "Creates or finds a ExpressionRouterRuleLanguage from its string representation."
|
||||
returns:
|
||||
description: "the corresponding ExpressionRouterRuleLanguage."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage?alt=com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage&text=ExpressionRouterRuleLanguage\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ExpressionRouterRuleLanguage.values()"
|
||||
summary: "Gets known Expression<wbr>Router<wbr>Rule<wbr>Language values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<ExpressionRouterRuleLanguage> values()"
|
||||
desc: "Gets known ExpressionRouterRuleLanguage values."
|
||||
returns:
|
||||
description: "known ExpressionRouterRuleLanguage values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage?alt=com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage&text=ExpressionRouterRuleLanguage\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Available expression languages that can be configured."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.FunctionRouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRule"
|
||||
name: "FunctionRouterRule"
|
||||
nameWithType: "FunctionRouterRule"
|
||||
summary: "A rule providing a binding to an HTTP Triggered Azure Function."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule.getKind()?alt=com.azure.communication.jobrouter.models.RouterRule.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **FunctionRouterRule**</br> extends <xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRule.FunctionRouterRule(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRule.FunctionRouterRule(String functionUri)"
|
||||
name: "FunctionRouterRule(String functionUri)"
|
||||
nameWithType: "FunctionRouterRule.FunctionRouterRule(String functionUri)"
|
||||
summary: "Creates an instance of Function<wbr>Router<wbr>Rule class."
|
||||
parameters:
|
||||
- description: "the functionUri value to set."
|
||||
name: "functionUri"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FunctionRouterRule(String functionUri)"
|
||||
desc: "Creates an instance of FunctionRouterRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRule.getCredential()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRule.getCredential()"
|
||||
name: "getCredential()"
|
||||
nameWithType: "FunctionRouterRule.getCredential()"
|
||||
summary: "Get the credential property: Credentials used to access Azure function rule."
|
||||
syntax: "public FunctionRouterRuleCredential getCredential()"
|
||||
desc: "Get the credential property: Credentials used to access Azure function rule."
|
||||
returns:
|
||||
description: "the credential value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRuleCredential?alt=com.azure.communication.jobrouter.models.FunctionRouterRuleCredential&text=FunctionRouterRuleCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRule.getFunctionUri()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRule.getFunctionUri()"
|
||||
name: "getFunctionUri()"
|
||||
nameWithType: "FunctionRouterRule.getFunctionUri()"
|
||||
summary: "Get the function<wbr>Uri property: URL for Azure Function."
|
||||
syntax: "public String getFunctionUri()"
|
||||
desc: "Get the functionUri property: URL for Azure Function."
|
||||
returns:
|
||||
description: "the functionUri value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRule.setCredential(com.azure.communication.jobrouter.models.FunctionRouterRuleCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRule.setCredential(FunctionRouterRuleCredential credential)"
|
||||
name: "setCredential(FunctionRouterRuleCredential credential)"
|
||||
nameWithType: "FunctionRouterRule.setCredential(FunctionRouterRuleCredential credential)"
|
||||
summary: "Set the credential property: Credentials used to access Azure function rule."
|
||||
parameters:
|
||||
- description: "the credential value to set."
|
||||
name: "credential"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRuleCredential?alt=com.azure.communication.jobrouter.models.FunctionRouterRuleCredential&text=FunctionRouterRuleCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public FunctionRouterRule setCredential(FunctionRouterRuleCredential credential)"
|
||||
desc: "Set the credential property: Credentials used to access Azure function rule."
|
||||
returns:
|
||||
description: "the FunctionRouterRule object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRule?alt=com.azure.communication.jobrouter.models.FunctionRouterRule&text=FunctionRouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rule providing a binding to an HTTP Triggered Azure Function."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential"
|
||||
name: "FunctionRouterRuleCredential"
|
||||
nameWithType: "FunctionRouterRuleCredential"
|
||||
summary: "Credentials used to access Azure function rule."
|
||||
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 **FunctionRouterRuleCredential**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.FunctionRouterRuleCredential()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.FunctionRouterRuleCredential()"
|
||||
name: "FunctionRouterRuleCredential()"
|
||||
nameWithType: "FunctionRouterRuleCredential.FunctionRouterRuleCredential()"
|
||||
summary: "Creates an instance of Function<wbr>Router<wbr>Rule<wbr>Credential class."
|
||||
syntax: "public FunctionRouterRuleCredential()"
|
||||
desc: "Creates an instance of FunctionRouterRuleCredential class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getAppKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getAppKey()"
|
||||
name: "getAppKey()"
|
||||
nameWithType: "FunctionRouterRuleCredential.getAppKey()"
|
||||
summary: "Get the app<wbr>Key property: Access key scoped to a Azure Function app."
|
||||
syntax: "public String getAppKey()"
|
||||
desc: "Get the appKey property: Access key scoped to a Azure Function app. This key grants access to all functions under the app."
|
||||
returns:
|
||||
description: "the appKey value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getClientId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getClientId()"
|
||||
name: "getClientId()"
|
||||
nameWithType: "FunctionRouterRuleCredential.getClientId()"
|
||||
summary: "Get the client<wbr>Id property: Client id, when App<wbr>Key is provided In context of Azure function, this is usually the name of the key."
|
||||
syntax: "public String getClientId()"
|
||||
desc: "Get the clientId property: Client id, when AppKey is provided In context of Azure function, this is usually the name of the key."
|
||||
returns:
|
||||
description: "the clientId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getFunctionKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.getFunctionKey()"
|
||||
name: "getFunctionKey()"
|
||||
nameWithType: "FunctionRouterRuleCredential.getFunctionKey()"
|
||||
summary: "Get the function<wbr>Key property: Access key scoped to a particular function."
|
||||
syntax: "public String getFunctionKey()"
|
||||
desc: "Get the functionKey property: Access key scoped to a particular function."
|
||||
returns:
|
||||
description: "the functionKey value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setAppKey(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setAppKey(String appKey)"
|
||||
name: "setAppKey(String appKey)"
|
||||
nameWithType: "FunctionRouterRuleCredential.setAppKey(String appKey)"
|
||||
summary: "Set the app<wbr>Key property: Access key scoped to a Azure Function app."
|
||||
parameters:
|
||||
- description: "the appKey value to set."
|
||||
name: "appKey"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FunctionRouterRuleCredential setAppKey(String appKey)"
|
||||
desc: "Set the appKey property: Access key scoped to a Azure Function app. This key grants access to all functions under the app."
|
||||
returns:
|
||||
description: "the FunctionRouterRuleCredential object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRuleCredential?alt=com.azure.communication.jobrouter.models.FunctionRouterRuleCredential&text=FunctionRouterRuleCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setClientId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setClientId(String clientId)"
|
||||
name: "setClientId(String clientId)"
|
||||
nameWithType: "FunctionRouterRuleCredential.setClientId(String clientId)"
|
||||
summary: "Set the client<wbr>Id property: Client id, when App<wbr>Key is provided In context of Azure function, this is usually the name of the key."
|
||||
parameters:
|
||||
- description: "the clientId value to set."
|
||||
name: "clientId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FunctionRouterRuleCredential setClientId(String clientId)"
|
||||
desc: "Set the clientId property: Client id, when AppKey is provided In context of Azure function, this is usually the name of the key."
|
||||
returns:
|
||||
description: "the FunctionRouterRuleCredential object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRuleCredential?alt=com.azure.communication.jobrouter.models.FunctionRouterRuleCredential&text=FunctionRouterRuleCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setFunctionKey(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential.setFunctionKey(String functionKey)"
|
||||
name: "setFunctionKey(String functionKey)"
|
||||
nameWithType: "FunctionRouterRuleCredential.setFunctionKey(String functionKey)"
|
||||
summary: "Set the function<wbr>Key property: Access key scoped to a particular function."
|
||||
parameters:
|
||||
- description: "the functionKey value to set."
|
||||
name: "functionKey"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public FunctionRouterRuleCredential setFunctionKey(String functionKey)"
|
||||
desc: "Set the functionKey property: Access key scoped to a particular function."
|
||||
returns:
|
||||
description: "the FunctionRouterRuleCredential object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.FunctionRouterRuleCredential?alt=com.azure.communication.jobrouter.models.FunctionRouterRuleCredential&text=FunctionRouterRuleCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Credentials used to access Azure function rule."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.JobMatchingMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.JobMatchingMode"
|
||||
name: "JobMatchingMode"
|
||||
nameWithType: "JobMatchingMode"
|
||||
summary: "A matching mode of one of the following types: Queue<wbr>And<wbr>Match<wbr>Mode: Used when matching worker to a job is required to be done right after job is queued."
|
||||
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 abstract class **JobMatchingMode**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.JobMatchingMode.JobMatchingMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.JobMatchingMode.JobMatchingMode()"
|
||||
name: "JobMatchingMode()"
|
||||
nameWithType: "JobMatchingMode.JobMatchingMode()"
|
||||
summary: "Creates an instance of Job<wbr>Matching<wbr>Mode class."
|
||||
syntax: "public JobMatchingMode()"
|
||||
desc: "Creates an instance of JobMatchingMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.JobMatchingMode.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.JobMatchingMode.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "JobMatchingMode.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "A matching mode of one of the following types: QueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. SuspendMode: Used when matching workers to a job needs to be suspended."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,145 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.LabelOperator"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator"
|
||||
name: "LabelOperator"
|
||||
nameWithType: "LabelOperator"
|
||||
summary: "Describes supported operations on label values."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **LabelOperator**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.LabelOperator()"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.LabelOperator()"
|
||||
name: "LabelOperator()"
|
||||
nameWithType: "LabelOperator.LabelOperator()"
|
||||
summary: "Creates a new instance of Label<wbr>Operator value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.LabelOperator.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public LabelOperator()"
|
||||
desc: "Creates a new instance of LabelOperator value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.EQUAL"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.EQUAL"
|
||||
name: "EQUAL"
|
||||
nameWithType: "LabelOperator.EQUAL"
|
||||
summary: "Equal."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator EQUAL"
|
||||
desc: "Equal."
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.GREATER_THAN"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.GREATER_THAN"
|
||||
name: "GREATER_THAN"
|
||||
nameWithType: "LabelOperator.GREATER_THAN"
|
||||
summary: "Greater than."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator GREATER_THAN"
|
||||
desc: "Greater than."
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.GREATER_THAN_OR_EQUAL"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.GREATER_THAN_OR_EQUAL"
|
||||
name: "GREATER_THAN_OR_EQUAL"
|
||||
nameWithType: "LabelOperator.GREATER_THAN_OR_EQUAL"
|
||||
summary: "Greater than or equal."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator GREATER_THAN_OR_EQUAL"
|
||||
desc: "Greater than or equal."
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.LESS_THAN"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.LESS_THAN"
|
||||
name: "LESS_THAN"
|
||||
nameWithType: "LabelOperator.LESS_THAN"
|
||||
summary: "Less than."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator LESS_THAN"
|
||||
desc: "Less than."
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.LESS_THAN_OR_EQUAL"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.LESS_THAN_OR_EQUAL"
|
||||
name: "LESS_THAN_OR_EQUAL"
|
||||
nameWithType: "LabelOperator.LESS_THAN_OR_EQUAL"
|
||||
summary: "Less than or equal."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator LESS_THAN_OR_EQUAL"
|
||||
desc: "Less than or equal."
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.NOT_EQUAL"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.NOT_EQUAL"
|
||||
name: "NOT_EQUAL"
|
||||
nameWithType: "LabelOperator.NOT_EQUAL"
|
||||
summary: "Not Equal."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final LabelOperator NOT_EQUAL"
|
||||
desc: "Not Equal."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "LabelOperator.fromString(String name)"
|
||||
summary: "Creates or finds a Label<wbr>Operator from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static LabelOperator fromString(String name)"
|
||||
desc: "Creates or finds a LabelOperator from its string representation."
|
||||
returns:
|
||||
description: "the corresponding LabelOperator."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.LabelOperator.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.LabelOperator.values()"
|
||||
name: "values()"
|
||||
nameWithType: "LabelOperator.values()"
|
||||
summary: "Gets known Label<wbr>Operator values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<LabelOperator> values()"
|
||||
desc: "Gets known LabelOperator values."
|
||||
returns:
|
||||
description: "known LabelOperator values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes supported operations on label values."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.LongestIdleMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.LongestIdleMode"
|
||||
name: "LongestIdleMode"
|
||||
nameWithType: "LongestIdleMode"
|
||||
summary: "Jobs are directed to the worker who has been idle longest."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getKind()?alt=com.azure.communication.jobrouter.models.DistributionMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers&text=getMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers&text=getMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors()?alt=com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors&text=isBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)?alt=com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors&text=setBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers&text=setMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers&text=setMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **LongestIdleMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.LongestIdleMode.LongestIdleMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.LongestIdleMode.LongestIdleMode()"
|
||||
name: "LongestIdleMode()"
|
||||
nameWithType: "LongestIdleMode.LongestIdleMode()"
|
||||
summary: "Creates an instance of Longest<wbr>Idle<wbr>Mode class."
|
||||
syntax: "public LongestIdleMode()"
|
||||
desc: "Creates an instance of LongestIdleMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.LongestIdleMode.setBypassSelectors(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.LongestIdleMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
name: "setBypassSelectors(Boolean bypassSelectors)"
|
||||
nameWithType: "LongestIdleMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
summary: "Set the bypass<wbr>Selectors property: If set to true, then router will match workers to jobs even if they don't match label selectors."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)"
|
||||
parameters:
|
||||
- name: "bypassSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public LongestIdleMode setBypassSelectors(Boolean bypassSelectors)"
|
||||
desc: "Set the bypassSelectors property: If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LongestIdleMode?alt=com.azure.communication.jobrouter.models.LongestIdleMode&text=LongestIdleMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.LongestIdleMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.LongestIdleMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
name: "setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
nameWithType: "LongestIdleMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
summary: "Set the max<wbr>Concurrent<wbr>Offers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "maxConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public LongestIdleMode setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
desc: "Set the maxConcurrentOffers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LongestIdleMode?alt=com.azure.communication.jobrouter.models.LongestIdleMode&text=LongestIdleMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.LongestIdleMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.LongestIdleMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
name: "setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
nameWithType: "LongestIdleMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
summary: "Set the min<wbr>Concurrent<wbr>Offers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "minConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public LongestIdleMode setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
desc: "Set the minConcurrentOffers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LongestIdleMode?alt=com.azure.communication.jobrouter.models.LongestIdleMode&text=LongestIdleMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Jobs are directed to the worker who has been idle longest."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction"
|
||||
name: "ManualReclassifyExceptionAction"
|
||||
nameWithType: "ManualReclassifyExceptionAction"
|
||||
summary: "An action that manually reclassifies a job by providing the queue, priority and worker selectors."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getId()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getKind()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ManualReclassifyExceptionAction**</br> extends <xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.ManualReclassifyExceptionAction()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.ManualReclassifyExceptionAction()"
|
||||
name: "ManualReclassifyExceptionAction()"
|
||||
nameWithType: "ManualReclassifyExceptionAction.ManualReclassifyExceptionAction()"
|
||||
summary: "Creates an instance of Manual<wbr>Reclassify<wbr>Exception<wbr>Action class."
|
||||
syntax: "public ManualReclassifyExceptionAction()"
|
||||
desc: "Creates an instance of ManualReclassifyExceptionAction class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getPriority()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getPriority()"
|
||||
name: "getPriority()"
|
||||
nameWithType: "ManualReclassifyExceptionAction.getPriority()"
|
||||
summary: "Get the priority property: Updated Priority."
|
||||
syntax: "public Integer getPriority()"
|
||||
desc: "Get the priority property: Updated Priority."
|
||||
returns:
|
||||
description: "the priority value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "ManualReclassifyExceptionAction.getQueueId()"
|
||||
summary: "Get the queue<wbr>Id property: Updated Queue<wbr>Id."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Get the queueId property: Updated QueueId."
|
||||
returns:
|
||||
description: "the queueId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.getWorkerSelectors()"
|
||||
name: "getWorkerSelectors()"
|
||||
nameWithType: "ManualReclassifyExceptionAction.getWorkerSelectors()"
|
||||
summary: "Get the worker<wbr>Selectors property: Updated Worker<wbr>Selectors."
|
||||
syntax: "public List<RouterWorkerSelector> getWorkerSelectors()"
|
||||
desc: "Get the workerSelectors property: Updated WorkerSelectors."
|
||||
returns:
|
||||
description: "the workerSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setPriority(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setPriority(Integer priority)"
|
||||
name: "setPriority(Integer priority)"
|
||||
nameWithType: "ManualReclassifyExceptionAction.setPriority(Integer priority)"
|
||||
summary: "Set the priority property: Updated Priority."
|
||||
parameters:
|
||||
- description: "the priority value to set."
|
||||
name: "priority"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public ManualReclassifyExceptionAction setPriority(Integer priority)"
|
||||
desc: "Set the priority property: Updated Priority."
|
||||
returns:
|
||||
description: "the ManualReclassifyExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction?alt=com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction&text=ManualReclassifyExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setQueueId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setQueueId(String queueId)"
|
||||
name: "setQueueId(String queueId)"
|
||||
nameWithType: "ManualReclassifyExceptionAction.setQueueId(String queueId)"
|
||||
summary: "Set the queue<wbr>Id property: Updated Queue<wbr>Id."
|
||||
parameters:
|
||||
- description: "the queueId value to set."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ManualReclassifyExceptionAction setQueueId(String queueId)"
|
||||
desc: "Set the queueId property: Updated QueueId."
|
||||
returns:
|
||||
description: "the ManualReclassifyExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction?alt=com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction&text=ManualReclassifyExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setWorkerSelectors(java.util.List<com.azure.communication.jobrouter.models.RouterWorkerSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction.setWorkerSelectors(List<RouterWorkerSelector> workerSelectors)"
|
||||
name: "setWorkerSelectors(List<RouterWorkerSelector> workerSelectors)"
|
||||
nameWithType: "ManualReclassifyExceptionAction.setWorkerSelectors(List<RouterWorkerSelector> workerSelectors)"
|
||||
summary: "Set the worker<wbr>Selectors property: Updated Worker<wbr>Selectors."
|
||||
parameters:
|
||||
- description: "the workerSelectors value to set."
|
||||
name: "workerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ManualReclassifyExceptionAction setWorkerSelectors(List<RouterWorkerSelector> workerSelectors)"
|
||||
desc: "Set the workerSelectors property: Updated WorkerSelectors."
|
||||
returns:
|
||||
description: "the ManualReclassifyExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction?alt=com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction&text=ManualReclassifyExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "An action that manually reclassifies a job by providing the queue, priority and worker selectors."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential"
|
||||
name: "OAuth2WebhookClientCredential"
|
||||
nameWithType: "OAuth2WebhookClientCredential"
|
||||
summary: "OAuth2.0 Credentials used to Contoso's Authorization server."
|
||||
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 **OAuth2WebhookClientCredential**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.OAuth2WebhookClientCredential()"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.OAuth2WebhookClientCredential()"
|
||||
name: "OAuth2WebhookClientCredential()"
|
||||
nameWithType: "OAuth2WebhookClientCredential.OAuth2WebhookClientCredential()"
|
||||
summary: "Creates an instance of OAuth2Webhook<wbr>Client<wbr>Credential class."
|
||||
syntax: "public OAuth2WebhookClientCredential()"
|
||||
desc: "Creates an instance of OAuth2WebhookClientCredential class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.getClientId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.getClientId()"
|
||||
name: "getClientId()"
|
||||
nameWithType: "OAuth2WebhookClientCredential.getClientId()"
|
||||
summary: "Get the client<wbr>Id property: Client<wbr>Id for Contoso Authorization server."
|
||||
syntax: "public String getClientId()"
|
||||
desc: "Get the clientId property: ClientId for Contoso Authorization server."
|
||||
returns:
|
||||
description: "the clientId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.getClientSecret()"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.getClientSecret()"
|
||||
name: "getClientSecret()"
|
||||
nameWithType: "OAuth2WebhookClientCredential.getClientSecret()"
|
||||
summary: "Get the client<wbr>Secret property: Client secret for Contoso Authorization server."
|
||||
syntax: "public String getClientSecret()"
|
||||
desc: "Get the clientSecret property: Client secret for Contoso Authorization server."
|
||||
returns:
|
||||
description: "the clientSecret value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.setClientId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.setClientId(String clientId)"
|
||||
name: "setClientId(String clientId)"
|
||||
nameWithType: "OAuth2WebhookClientCredential.setClientId(String clientId)"
|
||||
summary: "Set the client<wbr>Id property: Client<wbr>Id for Contoso Authorization server."
|
||||
parameters:
|
||||
- description: "the clientId value to set."
|
||||
name: "clientId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public OAuth2WebhookClientCredential setClientId(String clientId)"
|
||||
desc: "Set the clientId property: ClientId for Contoso Authorization server."
|
||||
returns:
|
||||
description: "the OAuth2WebhookClientCredential object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential?alt=com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential&text=OAuth2WebhookClientCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.setClientSecret(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential.setClientSecret(String clientSecret)"
|
||||
name: "setClientSecret(String clientSecret)"
|
||||
nameWithType: "OAuth2WebhookClientCredential.setClientSecret(String clientSecret)"
|
||||
summary: "Set the client<wbr>Secret property: Client secret for Contoso Authorization server."
|
||||
parameters:
|
||||
- description: "the clientSecret value to set."
|
||||
name: "clientSecret"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public OAuth2WebhookClientCredential setClientSecret(String clientSecret)"
|
||||
desc: "Set the clientSecret property: Client secret for Contoso Authorization server."
|
||||
returns:
|
||||
description: "the OAuth2WebhookClientCredential object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential?alt=com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential&text=OAuth2WebhookClientCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment"
|
||||
name: "PassThroughQueueSelectorAttachment"
|
||||
nameWithType: "PassThroughQueueSelectorAttachment"
|
||||
summary: "Attaches a queue selector where the value is passed through from the job label with the same key."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **PassThroughQueueSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.PassThroughQueueSelectorAttachment(java.lang.String,com.azure.communication.jobrouter.models.LabelOperator)"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.PassThroughQueueSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
name: "PassThroughQueueSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
nameWithType: "PassThroughQueueSelectorAttachment.PassThroughQueueSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
summary: "Creates an instance of Pass<wbr>Through<wbr>Queue<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the key value to set."
|
||||
name: "key"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the labelOperator value to set."
|
||||
name: "labelOperator"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public PassThroughQueueSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
desc: "Creates an instance of PassThroughQueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.getKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.getKey()"
|
||||
name: "getKey()"
|
||||
nameWithType: "PassThroughQueueSelectorAttachment.getKey()"
|
||||
summary: "Get the key property: The label key to query against."
|
||||
syntax: "public String getKey()"
|
||||
desc: "Get the key property: The label key to query against."
|
||||
returns:
|
||||
description: "the key value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.getLabelOperator()"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment.getLabelOperator()"
|
||||
name: "getLabelOperator()"
|
||||
nameWithType: "PassThroughQueueSelectorAttachment.getLabelOperator()"
|
||||
summary: "Get the label<wbr>Operator property: Describes how the value of the label is compared to the value pass through."
|
||||
syntax: "public LabelOperator getLabelOperator()"
|
||||
desc: "Get the labelOperator property: Describes how the value of the label is compared to the value pass through."
|
||||
returns:
|
||||
description: "the labelOperator value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Attaches a queue selector where the value is passed through from the job label with the same key."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment"
|
||||
name: "PassThroughWorkerSelectorAttachment"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment"
|
||||
summary: "Attaches a worker selector where the value is passed through from the job label with the same key."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **PassThroughWorkerSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.PassThroughWorkerSelectorAttachment(java.lang.String,com.azure.communication.jobrouter.models.LabelOperator)"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.PassThroughWorkerSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
name: "PassThroughWorkerSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment.PassThroughWorkerSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
summary: "Creates an instance of Pass<wbr>Through<wbr>Worker<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the key value to set."
|
||||
name: "key"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the labelOperator value to set."
|
||||
name: "labelOperator"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public PassThroughWorkerSelectorAttachment(String key, LabelOperator labelOperator)"
|
||||
desc: "Creates an instance of PassThroughWorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getExpiresAfter()"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getExpiresAfter()"
|
||||
name: "getExpiresAfter()"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment.getExpiresAfter()"
|
||||
summary: "Get the expires<wbr>After property: Describes how long the attached label selector is valid in seconds."
|
||||
syntax: "public Duration getExpiresAfter()"
|
||||
desc: "Get the expiresAfter property: Describes how long the attached label selector is valid in seconds."
|
||||
returns:
|
||||
description: "the expiresAfter value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getKey()"
|
||||
name: "getKey()"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment.getKey()"
|
||||
summary: "Get the key property: The label key to query against."
|
||||
syntax: "public String getKey()"
|
||||
desc: "Get the key property: The label key to query against."
|
||||
returns:
|
||||
description: "the key value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getLabelOperator()"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.getLabelOperator()"
|
||||
name: "getLabelOperator()"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment.getLabelOperator()"
|
||||
summary: "Get the label<wbr>Operator property: Describes how the value of the label is compared to the value pass through."
|
||||
syntax: "public LabelOperator getLabelOperator()"
|
||||
desc: "Get the labelOperator property: Describes how the value of the label is compared to the value pass through."
|
||||
returns:
|
||||
description: "the labelOperator value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.setExpiresAfter(java.time.Duration)"
|
||||
fullName: "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment.setExpiresAfter(Duration expiresAfter)"
|
||||
name: "setExpiresAfter(Duration expiresAfter)"
|
||||
nameWithType: "PassThroughWorkerSelectorAttachment.setExpiresAfter(Duration expiresAfter)"
|
||||
summary: "Set the expires<wbr>After property: Describes how long the attached label selector is valid in seconds."
|
||||
parameters:
|
||||
- description: "the expiresAfter value to set."
|
||||
name: "expiresAfter"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
syntax: "public PassThroughWorkerSelectorAttachment setExpiresAfter(Duration expiresAfter)"
|
||||
desc: "Set the expiresAfter property: Describes how long the attached label selector is valid in seconds."
|
||||
returns:
|
||||
description: "the PassThroughWorkerSelectorAttachment object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment&text=PassThroughWorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Attaches a worker selector where the value is passed through from the job label with the same key."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.QueueAndMatchMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueAndMatchMode"
|
||||
name: "QueueAndMatchMode"
|
||||
nameWithType: "QueueAndMatchMode"
|
||||
summary: "Describes a matching mode where matching worker to a job is automatically started after job is queued successfully."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode.getKind()?alt=com.azure.communication.jobrouter.models.JobMatchingMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **QueueAndMatchMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueAndMatchMode.QueueAndMatchMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueAndMatchMode.QueueAndMatchMode()"
|
||||
name: "QueueAndMatchMode()"
|
||||
nameWithType: "QueueAndMatchMode.QueueAndMatchMode()"
|
||||
summary: "Creates an instance of Queue<wbr>And<wbr>Match<wbr>Mode class."
|
||||
syntax: "public QueueAndMatchMode()"
|
||||
desc: "Creates an instance of QueueAndMatchMode class."
|
||||
type: "class"
|
||||
desc: "Describes a matching mode where matching worker to a job is automatically started after job is queued successfully."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger"
|
||||
name: "QueueLengthExceptionTrigger"
|
||||
nameWithType: "QueueLengthExceptionTrigger"
|
||||
summary: "Trigger for an exception action on exceeding queue length."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger.getKind()?alt=com.azure.communication.jobrouter.models.ExceptionTrigger.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **QueueLengthExceptionTrigger**</br> extends <xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger.QueueLengthExceptionTrigger(int)"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger.QueueLengthExceptionTrigger(int threshold)"
|
||||
name: "QueueLengthExceptionTrigger(int threshold)"
|
||||
nameWithType: "QueueLengthExceptionTrigger.QueueLengthExceptionTrigger(int threshold)"
|
||||
summary: "Creates an instance of Queue<wbr>Length<wbr>Exception<wbr>Trigger class."
|
||||
parameters:
|
||||
- description: "the threshold value to set."
|
||||
name: "threshold"
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public QueueLengthExceptionTrigger(int threshold)"
|
||||
desc: "Creates an instance of QueueLengthExceptionTrigger class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger.getThreshold()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger.getThreshold()"
|
||||
name: "getThreshold()"
|
||||
nameWithType: "QueueLengthExceptionTrigger.getThreshold()"
|
||||
summary: "Get the threshold property: Threshold of number of jobs ahead in the queue to for this trigger to fire."
|
||||
syntax: "public int getThreshold()"
|
||||
desc: "Get the threshold property: Threshold of number of jobs ahead in the queue to for this trigger to fire."
|
||||
returns:
|
||||
description: "the threshold value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Trigger for an exception action on exceeding queue length."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.QueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueSelectorAttachment"
|
||||
name: "QueueSelectorAttachment"
|
||||
nameWithType: "QueueSelectorAttachment"
|
||||
summary: "An attachment of queue selectors to resolve a queue to a job from a classification policy."
|
||||
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 abstract class **QueueSelectorAttachment**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueSelectorAttachment.QueueSelectorAttachment()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueSelectorAttachment.QueueSelectorAttachment()"
|
||||
name: "QueueSelectorAttachment()"
|
||||
nameWithType: "QueueSelectorAttachment.QueueSelectorAttachment()"
|
||||
summary: "Creates an instance of Queue<wbr>Selector<wbr>Attachment class."
|
||||
syntax: "public QueueSelectorAttachment()"
|
||||
desc: "Creates an instance of QueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "QueueSelectorAttachment.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "An attachment of queue selectors to resolve a queue to a job from a classification policy."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.QueueWeightedAllocation"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueWeightedAllocation"
|
||||
name: "QueueWeightedAllocation"
|
||||
nameWithType: "QueueWeightedAllocation"
|
||||
summary: "Contains the weight percentage and queue selectors to be applied if selected for weighted distributions."
|
||||
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 **QueueWeightedAllocation**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.QueueWeightedAllocation(double,java.util.List<com.azure.communication.jobrouter.models.RouterQueueSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.QueueWeightedAllocation(double weight, List<RouterQueueSelector> queueSelectors)"
|
||||
name: "QueueWeightedAllocation(double weight, List<RouterQueueSelector> queueSelectors)"
|
||||
nameWithType: "QueueWeightedAllocation.QueueWeightedAllocation(double weight, List<RouterQueueSelector> queueSelectors)"
|
||||
summary: "Creates an instance of Queue<wbr>Weighted<wbr>Allocation class."
|
||||
parameters:
|
||||
- description: "the weight value to set."
|
||||
name: "weight"
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the queueSelectors value to set."
|
||||
name: "queueSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public QueueWeightedAllocation(double weight, List<RouterQueueSelector> queueSelectors)"
|
||||
desc: "Creates an instance of QueueWeightedAllocation class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.getQueueSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.getQueueSelectors()"
|
||||
name: "getQueueSelectors()"
|
||||
nameWithType: "QueueWeightedAllocation.getQueueSelectors()"
|
||||
summary: "Get the queue<wbr>Selectors property: A collection of queue selectors that will be applied if this allocation is selected."
|
||||
syntax: "public List<RouterQueueSelector> getQueueSelectors()"
|
||||
desc: "Get the queueSelectors property: A collection of queue selectors that will be applied if this allocation is selected."
|
||||
returns:
|
||||
description: "the queueSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.getWeight()"
|
||||
fullName: "com.azure.communication.jobrouter.models.QueueWeightedAllocation.getWeight()"
|
||||
name: "getWeight()"
|
||||
nameWithType: "QueueWeightedAllocation.getWeight()"
|
||||
summary: "Get the weight property: The percentage of this weight, expressed as a fraction of 1."
|
||||
syntax: "public double getWeight()"
|
||||
desc: "Get the weight property: The percentage of this weight, expressed as a fraction of 1."
|
||||
returns:
|
||||
description: "the weight value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Contains the weight percentage and queue selectors to be applied if selected for weighted distributions."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction"
|
||||
name: "ReclassifyExceptionAction"
|
||||
nameWithType: "ReclassifyExceptionAction"
|
||||
summary: "An action that modifies labels on a job and then reclassifies it."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getId()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionAction.getKind()?alt=com.azure.communication.jobrouter.models.ExceptionAction.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ReclassifyExceptionAction**</br> extends <xref href=\"com.azure.communication.jobrouter.models.ExceptionAction?alt=com.azure.communication.jobrouter.models.ExceptionAction&text=ExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.ReclassifyExceptionAction()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.ReclassifyExceptionAction()"
|
||||
name: "ReclassifyExceptionAction()"
|
||||
nameWithType: "ReclassifyExceptionAction.ReclassifyExceptionAction()"
|
||||
summary: "Creates an instance of Reclassify<wbr>Exception<wbr>Action class."
|
||||
syntax: "public ReclassifyExceptionAction()"
|
||||
desc: "Creates an instance of ReclassifyExceptionAction class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.getClassificationPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.getClassificationPolicyId()"
|
||||
name: "getClassificationPolicyId()"
|
||||
nameWithType: "ReclassifyExceptionAction.getClassificationPolicyId()"
|
||||
summary: "Get the classification<wbr>Policy<wbr>Id property: (optional) The new classification policy that will determine queue, priority and worker selectors."
|
||||
syntax: "public String getClassificationPolicyId()"
|
||||
desc: "Get the classificationPolicyId property: (optional) The new classification policy that will determine queue, priority and worker selectors."
|
||||
returns:
|
||||
description: "the classificationPolicyId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.getLabelsToUpsert()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.getLabelsToUpsert()"
|
||||
name: "getLabelsToUpsert()"
|
||||
nameWithType: "ReclassifyExceptionAction.getLabelsToUpsert()"
|
||||
summary: "Get the labels<wbr>ToUpsert property: (optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs."
|
||||
syntax: "public Map<String,RouterValue> getLabelsToUpsert()"
|
||||
desc: "Get the labelsToUpsert property: (optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs."
|
||||
returns:
|
||||
description: "the labelsToUpsert value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.setClassificationPolicyId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.setClassificationPolicyId(String classificationPolicyId)"
|
||||
name: "setClassificationPolicyId(String classificationPolicyId)"
|
||||
nameWithType: "ReclassifyExceptionAction.setClassificationPolicyId(String classificationPolicyId)"
|
||||
summary: "Set the classification<wbr>Policy<wbr>Id property: (optional) The new classification policy that will determine queue, priority and worker selectors."
|
||||
parameters:
|
||||
- description: "the classificationPolicyId value to set."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ReclassifyExceptionAction setClassificationPolicyId(String classificationPolicyId)"
|
||||
desc: "Set the classificationPolicyId property: (optional) The new classification policy that will determine queue, priority and worker selectors."
|
||||
returns:
|
||||
description: "the ReclassifyExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ReclassifyExceptionAction?alt=com.azure.communication.jobrouter.models.ReclassifyExceptionAction&text=ReclassifyExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.setLabelsToUpsert(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyExceptionAction.setLabelsToUpsert(Map<String,RouterValue> labelsToUpsert)"
|
||||
name: "setLabelsToUpsert(Map<String,RouterValue> labelsToUpsert)"
|
||||
nameWithType: "ReclassifyExceptionAction.setLabelsToUpsert(Map<String,RouterValue> labelsToUpsert)"
|
||||
summary: "Set the labels<wbr>ToUpsert property: (optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs."
|
||||
parameters:
|
||||
- description: "the labelsToUpsert value to set."
|
||||
name: "labelsToUpsert"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ReclassifyExceptionAction setLabelsToUpsert(Map<String,RouterValue> labelsToUpsert)"
|
||||
desc: "Set the labelsToUpsert property: (optional) Dictionary containing the labels to update (or add if not existing) in key-value pairs."
|
||||
returns:
|
||||
description: "the ReclassifyExceptionAction object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ReclassifyExceptionAction?alt=com.azure.communication.jobrouter.models.ReclassifyExceptionAction&text=ReclassifyExceptionAction\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "An action that modifies labels on a job and then reclassifies it."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ReclassifyJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyJobOptions"
|
||||
name: "ReclassifyJobOptions"
|
||||
nameWithType: "ReclassifyJobOptions"
|
||||
summary: "Request payload for reclassifying jobs."
|
||||
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 **ReclassifyJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyJobOptions.ReclassifyJobOptions(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyJobOptions.ReclassifyJobOptions(String jobId)"
|
||||
name: "ReclassifyJobOptions(String jobId)"
|
||||
nameWithType: "ReclassifyJobOptions.ReclassifyJobOptions(String jobId)"
|
||||
summary: "Creates an instance of Reclassify<wbr>Job<wbr>Options<wbr>Internal class."
|
||||
parameters:
|
||||
- description: "jobId."
|
||||
name: "jobId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public ReclassifyJobOptions(String jobId)"
|
||||
desc: "Creates an instance of ReclassifyJobOptionsInternal class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyJobOptions.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyJobOptions.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "ReclassifyJobOptions.getJobId()"
|
||||
summary: "Get id."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get id."
|
||||
returns:
|
||||
description: "id."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Request payload for reclassifying jobs."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ReclassifyJobOptionsInternal"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyJobOptionsInternal"
|
||||
name: "ReclassifyJobOptionsInternal"
|
||||
nameWithType: "ReclassifyJobOptionsInternal"
|
||||
summary: "Request payload for reclassifying jobs."
|
||||
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 **ReclassifyJobOptionsInternal**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ReclassifyJobOptionsInternal.ReclassifyJobOptionsInternal()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ReclassifyJobOptionsInternal.ReclassifyJobOptionsInternal()"
|
||||
name: "ReclassifyJobOptionsInternal()"
|
||||
nameWithType: "ReclassifyJobOptionsInternal.ReclassifyJobOptionsInternal()"
|
||||
summary: "Creates an instance of Reclassify<wbr>Job<wbr>Options<wbr>Internal class."
|
||||
syntax: "public ReclassifyJobOptionsInternal()"
|
||||
desc: "Creates an instance of ReclassifyJobOptionsInternal class."
|
||||
type: "class"
|
||||
desc: "Request payload for reclassifying jobs."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,86 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RoundRobinMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.RoundRobinMode"
|
||||
name: "RoundRobinMode"
|
||||
nameWithType: "RoundRobinMode"
|
||||
summary: "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getKind()?alt=com.azure.communication.jobrouter.models.DistributionMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMaxConcurrentOffers&text=getMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers()?alt=com.azure.communication.jobrouter.models.DistributionMode.getMinConcurrentOffers&text=getMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors()?alt=com.azure.communication.jobrouter.models.DistributionMode.isBypassSelectors&text=isBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)?alt=com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors&text=setBypassSelectors\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers&text=setMaxConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)?alt=com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers&text=setMinConcurrentOffers\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **RoundRobinMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.DistributionMode?alt=com.azure.communication.jobrouter.models.DistributionMode&text=DistributionMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RoundRobinMode.RoundRobinMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RoundRobinMode.RoundRobinMode()"
|
||||
name: "RoundRobinMode()"
|
||||
nameWithType: "RoundRobinMode.RoundRobinMode()"
|
||||
summary: "Creates an instance of Round<wbr>Robin<wbr>Mode class."
|
||||
syntax: "public RoundRobinMode()"
|
||||
desc: "Creates an instance of RoundRobinMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RoundRobinMode.setBypassSelectors(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RoundRobinMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
name: "setBypassSelectors(Boolean bypassSelectors)"
|
||||
nameWithType: "RoundRobinMode.setBypassSelectors(Boolean bypassSelectors)"
|
||||
summary: "Set the bypass<wbr>Selectors property: If set to true, then router will match workers to jobs even if they don't match label selectors."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setBypassSelectors(java.lang.Boolean)"
|
||||
parameters:
|
||||
- name: "bypassSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public RoundRobinMode setBypassSelectors(Boolean bypassSelectors)"
|
||||
desc: "Set the bypassSelectors property: If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RoundRobinMode?alt=com.azure.communication.jobrouter.models.RoundRobinMode&text=RoundRobinMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RoundRobinMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RoundRobinMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
name: "setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
nameWithType: "RoundRobinMode.setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
summary: "Set the max<wbr>Concurrent<wbr>Offers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMaxConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "maxConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RoundRobinMode setMaxConcurrentOffers(Integer maxConcurrentOffers)"
|
||||
desc: "Set the maxConcurrentOffers property: Governs the maximum number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RoundRobinMode?alt=com.azure.communication.jobrouter.models.RoundRobinMode&text=RoundRobinMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RoundRobinMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RoundRobinMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
name: "setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
nameWithType: "RoundRobinMode.setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
summary: "Set the min<wbr>Concurrent<wbr>Offers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
overridden: "com.azure.communication.jobrouter.models.DistributionMode.setMinConcurrentOffers(java.lang.Integer)"
|
||||
parameters:
|
||||
- name: "minConcurrentOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RoundRobinMode setMinConcurrentOffers(Integer minConcurrentOffers)"
|
||||
desc: "Set the minConcurrentOffers property: Governs the minimum desired number of active concurrent offers a job can have."
|
||||
returns:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RoundRobinMode?alt=com.azure.communication.jobrouter.models.RoundRobinMode&text=RoundRobinMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Jobs are distributed in order to workers, starting with the worker that is after the last worker to receive a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterChannel"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel"
|
||||
name: "RouterChannel"
|
||||
nameWithType: "RouterChannel"
|
||||
summary: "Represents the capacity a job in this channel will consume from a worker."
|
||||
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 **RouterChannel**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterChannel.RouterChannel(java.lang.String,int)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel.RouterChannel(String channelId, int capacityCostPerJob)"
|
||||
name: "RouterChannel(String channelId, int capacityCostPerJob)"
|
||||
nameWithType: "RouterChannel.RouterChannel(String channelId, int capacityCostPerJob)"
|
||||
summary: "Creates an instance of Router<wbr>Channel class."
|
||||
parameters:
|
||||
- description: "the channelId value to set."
|
||||
name: "channelId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the capacityCostPerJob value to set."
|
||||
name: "capacityCostPerJob"
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterChannel(String channelId, int capacityCostPerJob)"
|
||||
desc: "Creates an instance of RouterChannel class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterChannel.getCapacityCostPerJob()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel.getCapacityCostPerJob()"
|
||||
name: "getCapacityCostPerJob()"
|
||||
nameWithType: "RouterChannel.getCapacityCostPerJob()"
|
||||
summary: "Get the capacity<wbr>Cost<wbr>Per<wbr>Job property: The amount of capacity that an instance of a job of this channel will consume of the total worker capacity."
|
||||
syntax: "public int getCapacityCostPerJob()"
|
||||
desc: "Get the capacityCostPerJob property: The amount of capacity that an instance of a job of this channel will consume of the total worker capacity."
|
||||
returns:
|
||||
description: "the capacityCostPerJob value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterChannel.getChannelId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel.getChannelId()"
|
||||
name: "getChannelId()"
|
||||
nameWithType: "RouterChannel.getChannelId()"
|
||||
summary: "Get the channel<wbr>Id property: Id of a channel."
|
||||
syntax: "public String getChannelId()"
|
||||
desc: "Get the channelId property: Id of a channel."
|
||||
returns:
|
||||
description: "the channelId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterChannel.getMaxNumberOfJobs()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel.getMaxNumberOfJobs()"
|
||||
name: "getMaxNumberOfJobs()"
|
||||
nameWithType: "RouterChannel.getMaxNumberOfJobs()"
|
||||
summary: "Get the max<wbr>Number<wbr>OfJobs property: The maximum number of jobs that can be supported concurrently for this channel."
|
||||
syntax: "public Integer getMaxNumberOfJobs()"
|
||||
desc: "Get the maxNumberOfJobs property: The maximum number of jobs that can be supported concurrently for this channel."
|
||||
returns:
|
||||
description: "the maxNumberOfJobs value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterChannel.setMaxNumberOfJobs(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterChannel.setMaxNumberOfJobs(Integer maxNumberOfJobs)"
|
||||
name: "setMaxNumberOfJobs(Integer maxNumberOfJobs)"
|
||||
nameWithType: "RouterChannel.setMaxNumberOfJobs(Integer maxNumberOfJobs)"
|
||||
summary: "Set the max<wbr>Number<wbr>OfJobs property: The maximum number of jobs that can be supported concurrently for this channel."
|
||||
parameters:
|
||||
- description: "the maxNumberOfJobs value to set."
|
||||
name: "maxNumberOfJobs"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RouterChannel setMaxNumberOfJobs(Integer maxNumberOfJobs)"
|
||||
desc: "Set the maxNumberOfJobs property: The maximum number of jobs that can be supported concurrently for this channel."
|
||||
returns:
|
||||
description: "the RouterChannel object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterChannel?alt=com.azure.communication.jobrouter.models.RouterChannel&text=RouterChannel\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Represents the capacity a job in this channel will consume from a worker."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,371 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJob"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob"
|
||||
name: "RouterJob"
|
||||
nameWithType: "RouterJob"
|
||||
summary: "A unit of work to be routed."
|
||||
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 **RouterJob**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.RouterJob()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.RouterJob()"
|
||||
name: "RouterJob()"
|
||||
nameWithType: "RouterJob.RouterJob()"
|
||||
summary: "Creates an instance of Router<wbr>Job class."
|
||||
syntax: "public RouterJob()"
|
||||
desc: "Creates an instance of RouterJob class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getAssignments()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getAssignments()"
|
||||
name: "getAssignments()"
|
||||
nameWithType: "RouterJob.getAssignments()"
|
||||
summary: "Get the assignments property: A collection of the assignments of the job."
|
||||
syntax: "public Map<String,RouterJobAssignment> getAssignments()"
|
||||
desc: "Get the assignments property: A collection of the assignments of the job. Key is AssignmentId."
|
||||
returns:
|
||||
description: "the assignments value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterJobAssignment?alt=com.azure.communication.jobrouter.models.RouterJobAssignment&text=RouterJobAssignment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getAttachedWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getAttachedWorkerSelectors()"
|
||||
name: "getAttachedWorkerSelectors()"
|
||||
nameWithType: "RouterJob.getAttachedWorkerSelectors()"
|
||||
summary: "Get the attached<wbr>Worker<wbr>Selectors property: A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job."
|
||||
syntax: "public List<RouterWorkerSelector> getAttachedWorkerSelectors()"
|
||||
desc: "Get the attachedWorkerSelectors property: A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job."
|
||||
returns:
|
||||
description: "the attachedWorkerSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getChannelId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getChannelId()"
|
||||
name: "getChannelId()"
|
||||
nameWithType: "RouterJob.getChannelId()"
|
||||
summary: "Get the channel<wbr>Id property: The channel identifier."
|
||||
syntax: "public String getChannelId()"
|
||||
desc: "Get the channelId property: The channel identifier. eg. voice, chat, etc."
|
||||
returns:
|
||||
description: "the channelId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getChannelReference()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getChannelReference()"
|
||||
name: "getChannelReference()"
|
||||
nameWithType: "RouterJob.getChannelReference()"
|
||||
summary: "Get the channel<wbr>Reference property: Reference to an external parent context, eg."
|
||||
syntax: "public String getChannelReference()"
|
||||
desc: "Get the channelReference property: Reference to an external parent context, eg. call ID."
|
||||
returns:
|
||||
description: "the channelReference value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getClassificationPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getClassificationPolicyId()"
|
||||
name: "getClassificationPolicyId()"
|
||||
nameWithType: "RouterJob.getClassificationPolicyId()"
|
||||
summary: "Get the classification<wbr>Policy<wbr>Id property: The Id of the Classification policy used for classifying a job."
|
||||
syntax: "public String getClassificationPolicyId()"
|
||||
desc: "Get the classificationPolicyId property: The Id of the Classification policy used for classifying a job."
|
||||
returns:
|
||||
description: "the classificationPolicyId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getDispositionCode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getDispositionCode()"
|
||||
name: "getDispositionCode()"
|
||||
nameWithType: "RouterJob.getDispositionCode()"
|
||||
summary: "Get the disposition<wbr>Code property: Reason code for cancelled or closed jobs."
|
||||
syntax: "public String getDispositionCode()"
|
||||
desc: "Get the dispositionCode property: Reason code for cancelled or closed jobs."
|
||||
returns:
|
||||
description: "the dispositionCode value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getEnqueuedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getEnqueuedAt()"
|
||||
name: "getEnqueuedAt()"
|
||||
nameWithType: "RouterJob.getEnqueuedAt()"
|
||||
summary: "Get the enqueued<wbr>At property: The time a job was queued in UTC."
|
||||
syntax: "public OffsetDateTime getEnqueuedAt()"
|
||||
desc: "Get the enqueuedAt property: The time a job was queued in UTC."
|
||||
returns:
|
||||
description: "the enqueuedAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "RouterJob.getEtag()"
|
||||
summary: "Get the etag property: Concurrency Token."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: Concurrency Token."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "RouterJob.getId()"
|
||||
summary: "Get the id property: The id of the job."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The id of the job."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "RouterJob.getLabels()"
|
||||
summary: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the labels value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getMatchingMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getMatchingMode()"
|
||||
name: "getMatchingMode()"
|
||||
nameWithType: "RouterJob.getMatchingMode()"
|
||||
summary: "Get the matching<wbr>Mode property: The matching mode to be applied to this job."
|
||||
syntax: "public JobMatchingMode getMatchingMode()"
|
||||
desc: "Get the matchingMode property: The matching mode to be applied to this job.\n\nSupported types:\n\nQueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. SuspendMode: Used when matching workers to a job needs to be suspended."
|
||||
returns:
|
||||
description: "the matchingMode value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getNotes()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getNotes()"
|
||||
name: "getNotes()"
|
||||
nameWithType: "RouterJob.getNotes()"
|
||||
summary: "Get the notes property: Notes attached to a job, sorted by timestamp."
|
||||
syntax: "public List<RouterJobNote> getNotes()"
|
||||
desc: "Get the notes property: Notes attached to a job, sorted by timestamp."
|
||||
returns:
|
||||
description: "the notes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobNote?alt=com.azure.communication.jobrouter.models.RouterJobNote&text=RouterJobNote\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getPriority()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getPriority()"
|
||||
name: "getPriority()"
|
||||
nameWithType: "RouterJob.getPriority()"
|
||||
summary: "Get the priority property: The priority of this job."
|
||||
syntax: "public Integer getPriority()"
|
||||
desc: "Get the priority property: The priority of this job."
|
||||
returns:
|
||||
description: "the priority value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "RouterJob.getQueueId()"
|
||||
summary: "Get the queue<wbr>Id property: The Id of the Queue that this job is queued to."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Get the queueId property: The Id of the Queue that this job is queued to."
|
||||
returns:
|
||||
description: "the queueId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getRequestedWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getRequestedWorkerSelectors()"
|
||||
name: "getRequestedWorkerSelectors()"
|
||||
nameWithType: "RouterJob.getRequestedWorkerSelectors()"
|
||||
summary: "Get the requested<wbr>Worker<wbr>Selectors property: A collection of manually specified label selectors, which a worker must satisfy in order to process this job."
|
||||
syntax: "public List<RouterWorkerSelector> getRequestedWorkerSelectors()"
|
||||
desc: "Get the requestedWorkerSelectors property: A collection of manually specified label selectors, which a worker must satisfy in order to process this job."
|
||||
returns:
|
||||
description: "the requestedWorkerSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getScheduledAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getScheduledAt()"
|
||||
name: "getScheduledAt()"
|
||||
nameWithType: "RouterJob.getScheduledAt()"
|
||||
summary: "Get the scheduled<wbr>At property: If set, job will be scheduled to be enqueued at a given time."
|
||||
syntax: "public OffsetDateTime getScheduledAt()"
|
||||
desc: "Get the scheduledAt property: If set, job will be scheduled to be enqueued at a given time."
|
||||
returns:
|
||||
description: "the scheduledAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getStatus()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getStatus()"
|
||||
name: "getStatus()"
|
||||
nameWithType: "RouterJob.getStatus()"
|
||||
summary: "Get the status property: The status of the Job."
|
||||
syntax: "public RouterJobStatus getStatus()"
|
||||
desc: "Get the status property: The status of the Job."
|
||||
returns:
|
||||
description: "the status value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.getTags()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "RouterJob.getTags()"
|
||||
summary: "Get the tags property: A set of non-identifying attributes attached to this job."
|
||||
syntax: "public Map<String,RouterValue> getTags()"
|
||||
desc: "Get the tags property: A set of non-identifying attributes attached to this job."
|
||||
returns:
|
||||
description: "the tags value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJob.setChannelId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setChannelId(String channelId)"
|
||||
name: "setChannelId(String channelId)"
|
||||
nameWithType: "RouterJob.setChannelId(String channelId)"
|
||||
summary: "Set the channel<wbr>Id property: The channel identifier."
|
||||
parameters:
|
||||
- description: "the channelId value to set."
|
||||
name: "channelId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJob setChannelId(String channelId)"
|
||||
desc: "Set the channelId property: The channel identifier. eg. voice, chat, etc."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setChannelReference(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setChannelReference(String channelReference)"
|
||||
name: "setChannelReference(String channelReference)"
|
||||
nameWithType: "RouterJob.setChannelReference(String channelReference)"
|
||||
summary: "Set the channel<wbr>Reference property: Reference to an external parent context, eg."
|
||||
parameters:
|
||||
- description: "the channelReference value to set."
|
||||
name: "channelReference"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJob setChannelReference(String channelReference)"
|
||||
desc: "Set the channelReference property: Reference to an external parent context, eg. call ID."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setClassificationPolicyId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setClassificationPolicyId(String classificationPolicyId)"
|
||||
name: "setClassificationPolicyId(String classificationPolicyId)"
|
||||
nameWithType: "RouterJob.setClassificationPolicyId(String classificationPolicyId)"
|
||||
summary: "Set the classification<wbr>Policy<wbr>Id property: The Id of the Classification policy used for classifying a job."
|
||||
parameters:
|
||||
- description: "the classificationPolicyId value to set."
|
||||
name: "classificationPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJob setClassificationPolicyId(String classificationPolicyId)"
|
||||
desc: "Set the classificationPolicyId property: The Id of the Classification policy used for classifying a job."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setDispositionCode(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setDispositionCode(String dispositionCode)"
|
||||
name: "setDispositionCode(String dispositionCode)"
|
||||
nameWithType: "RouterJob.setDispositionCode(String dispositionCode)"
|
||||
summary: "Set the disposition<wbr>Code property: Reason code for cancelled or closed jobs."
|
||||
parameters:
|
||||
- description: "the dispositionCode value to set."
|
||||
name: "dispositionCode"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJob setDispositionCode(String dispositionCode)"
|
||||
desc: "Set the dispositionCode property: Reason code for cancelled or closed jobs."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "RouterJob.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
parameters:
|
||||
- description: "the labels value to set."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterJob setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setMatchingMode(com.azure.communication.jobrouter.models.JobMatchingMode)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setMatchingMode(JobMatchingMode matchingMode)"
|
||||
name: "setMatchingMode(JobMatchingMode matchingMode)"
|
||||
nameWithType: "RouterJob.setMatchingMode(JobMatchingMode matchingMode)"
|
||||
summary: "Set the matching<wbr>Mode property: The matching mode to be applied to this job."
|
||||
parameters:
|
||||
- description: "the matchingMode value to set."
|
||||
name: "matchingMode"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterJob setMatchingMode(JobMatchingMode matchingMode)"
|
||||
desc: "Set the matchingMode property: The matching mode to be applied to this job.\n\nSupported types:\n\nQueueAndMatchMode: Used when matching worker to a job is required to be done right after job is queued. ScheduleAndSuspendMode: Used for scheduling jobs to be queued at a future time. At specified time, matching of a worker to the job will not start automatically. SuspendMode: Used when matching workers to a job needs to be suspended."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setNotes(java.util.List<com.azure.communication.jobrouter.models.RouterJobNote>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setNotes(List<RouterJobNote> notes)"
|
||||
name: "setNotes(List<RouterJobNote> notes)"
|
||||
nameWithType: "RouterJob.setNotes(List<RouterJobNote> notes)"
|
||||
summary: "Set the notes property: Notes attached to a job, sorted by timestamp."
|
||||
parameters:
|
||||
- description: "the notes value to set."
|
||||
name: "notes"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobNote?alt=com.azure.communication.jobrouter.models.RouterJobNote&text=RouterJobNote\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterJob setNotes(List<RouterJobNote> notes)"
|
||||
desc: "Set the notes property: Notes attached to a job, sorted by timestamp."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setPriority(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setPriority(Integer priority)"
|
||||
name: "setPriority(Integer priority)"
|
||||
nameWithType: "RouterJob.setPriority(Integer priority)"
|
||||
summary: "Set the priority property: The priority of this job."
|
||||
parameters:
|
||||
- description: "the priority value to set."
|
||||
name: "priority"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RouterJob setPriority(Integer priority)"
|
||||
desc: "Set the priority property: The priority of this job."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setQueueId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setQueueId(String queueId)"
|
||||
name: "setQueueId(String queueId)"
|
||||
nameWithType: "RouterJob.setQueueId(String queueId)"
|
||||
summary: "Set the queue<wbr>Id property: The Id of the Queue that this job is queued to."
|
||||
parameters:
|
||||
- description: "the queueId value to set."
|
||||
name: "queueId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJob setQueueId(String queueId)"
|
||||
desc: "Set the queueId property: The Id of the Queue that this job is queued to."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setRequestedWorkerSelectors(java.util.List<com.azure.communication.jobrouter.models.RouterWorkerSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
name: "setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
nameWithType: "RouterJob.setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
summary: "Set the requested<wbr>Worker<wbr>Selectors property: A collection of manually specified label selectors, which a worker must satisfy in order to process this job."
|
||||
parameters:
|
||||
- description: "the requestedWorkerSelectors value to set."
|
||||
name: "requestedWorkerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterJob setRequestedWorkerSelectors(List<RouterWorkerSelector> requestedWorkerSelectors)"
|
||||
desc: "Set the requestedWorkerSelectors property: A collection of manually specified label selectors, which a worker must satisfy in order to process this job."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<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.models.RouterJob.setTags(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJob.setTags(Map<String,RouterValue> tags)"
|
||||
name: "setTags(Map<String,RouterValue> tags)"
|
||||
nameWithType: "RouterJob.setTags(Map<String,RouterValue> tags)"
|
||||
summary: "Set the tags property: A set of non-identifying attributes attached to this job."
|
||||
parameters:
|
||||
- description: "the tags value to set."
|
||||
name: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterJob setTags(Map<String,RouterValue> tags)"
|
||||
desc: "Set the tags property: A set of non-identifying attributes attached to this job."
|
||||
returns:
|
||||
description: "the RouterJob object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJob?alt=com.azure.communication.jobrouter.models.RouterJob&text=RouterJob\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A unit of work to be routed."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobAssignment"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment"
|
||||
name: "RouterJobAssignment"
|
||||
nameWithType: "RouterJobAssignment"
|
||||
summary: "Assignment details of a job to a worker."
|
||||
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 **RouterJobAssignment**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobAssignment.getAssignedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment.getAssignedAt()"
|
||||
name: "getAssignedAt()"
|
||||
nameWithType: "RouterJobAssignment.getAssignedAt()"
|
||||
summary: "Get the assigned<wbr>At property: Timestamp when the job was assigned to a worker in UTC."
|
||||
syntax: "public OffsetDateTime getAssignedAt()"
|
||||
desc: "Get the assignedAt property: Timestamp when the job was assigned to a worker in UTC."
|
||||
returns:
|
||||
description: "the assignedAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobAssignment.getAssignmentId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment.getAssignmentId()"
|
||||
name: "getAssignmentId()"
|
||||
nameWithType: "RouterJobAssignment.getAssignmentId()"
|
||||
summary: "Get the assignment<wbr>Id property: Id of a job assignment."
|
||||
syntax: "public String getAssignmentId()"
|
||||
desc: "Get the assignmentId property: Id of a job assignment."
|
||||
returns:
|
||||
description: "the assignmentId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobAssignment.getClosedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment.getClosedAt()"
|
||||
name: "getClosedAt()"
|
||||
nameWithType: "RouterJobAssignment.getClosedAt()"
|
||||
summary: "Get the closed<wbr>At property: Timestamp when the job was marked as closed after being completed in UTC."
|
||||
syntax: "public OffsetDateTime getClosedAt()"
|
||||
desc: "Get the closedAt property: Timestamp when the job was marked as closed after being completed in UTC."
|
||||
returns:
|
||||
description: "the closedAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobAssignment.getCompletedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment.getCompletedAt()"
|
||||
name: "getCompletedAt()"
|
||||
nameWithType: "RouterJobAssignment.getCompletedAt()"
|
||||
summary: "Get the completed<wbr>At property: Timestamp when the job was marked as completed after being assigned in UTC."
|
||||
syntax: "public OffsetDateTime getCompletedAt()"
|
||||
desc: "Get the completedAt property: Timestamp when the job was marked as completed after being assigned in UTC."
|
||||
returns:
|
||||
description: "the completedAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobAssignment.getWorkerId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobAssignment.getWorkerId()"
|
||||
name: "getWorkerId()"
|
||||
nameWithType: "RouterJobAssignment.getWorkerId()"
|
||||
summary: "Get the worker<wbr>Id property: Id of the Worker assigned to the job."
|
||||
syntax: "public String getWorkerId()"
|
||||
desc: "Get the workerId property: Id of the Worker assigned to the job."
|
||||
returns:
|
||||
description: "the workerId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Assignment details of a job to a worker."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobNote"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobNote"
|
||||
name: "RouterJobNote"
|
||||
nameWithType: "RouterJobNote"
|
||||
summary: "A note attached to a job."
|
||||
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 **RouterJobNote**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobNote.RouterJobNote(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobNote.RouterJobNote(String message)"
|
||||
name: "RouterJobNote(String message)"
|
||||
nameWithType: "RouterJobNote.RouterJobNote(String message)"
|
||||
summary: "Creates an instance of Router<wbr>Job<wbr>Note class."
|
||||
parameters:
|
||||
- description: "The message for the note."
|
||||
name: "message"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterJobNote(String message)"
|
||||
desc: "Creates an instance of RouterJobNote class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobNote.getAddedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobNote.getAddedAt()"
|
||||
name: "getAddedAt()"
|
||||
nameWithType: "RouterJobNote.getAddedAt()"
|
||||
summary: "getter for added<wbr>At."
|
||||
syntax: "public OffsetDateTime getAddedAt()"
|
||||
desc: "getter for addedAt."
|
||||
returns:
|
||||
description: "addedAt"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobNote.getMessage()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobNote.getMessage()"
|
||||
name: "getMessage()"
|
||||
nameWithType: "RouterJobNote.getMessage()"
|
||||
summary: "Getter for message."
|
||||
syntax: "public String getMessage()"
|
||||
desc: "Getter for message."
|
||||
returns:
|
||||
description: "message."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobNote.setAddedAt(java.time.OffsetDateTime)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobNote.setAddedAt(OffsetDateTime addedAt)"
|
||||
name: "setAddedAt(OffsetDateTime addedAt)"
|
||||
nameWithType: "RouterJobNote.setAddedAt(OffsetDateTime addedAt)"
|
||||
summary: "setter for time."
|
||||
parameters:
|
||||
- description: "time at which the note was added in UTC."
|
||||
name: "addedAt"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
syntax: "public RouterJobNote setAddedAt(OffsetDateTime addedAt)"
|
||||
desc: "setter for time."
|
||||
returns:
|
||||
description: "this"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobNote?alt=com.azure.communication.jobrouter.models.RouterJobNote&text=RouterJobNote\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A note attached to a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobOffer"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer"
|
||||
name: "RouterJobOffer"
|
||||
nameWithType: "RouterJobOffer"
|
||||
summary: "An offer of a job to a worker."
|
||||
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 **RouterJobOffer**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobOffer.getCapacityCost()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer.getCapacityCost()"
|
||||
name: "getCapacityCost()"
|
||||
nameWithType: "RouterJobOffer.getCapacityCost()"
|
||||
summary: "Get the capacity<wbr>Cost property: The capacity cost consumed by the job offer."
|
||||
syntax: "public int getCapacityCost()"
|
||||
desc: "Get the capacityCost property: The capacity cost consumed by the job offer."
|
||||
returns:
|
||||
description: "the capacityCost value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobOffer.getExpiresAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer.getExpiresAt()"
|
||||
name: "getExpiresAt()"
|
||||
nameWithType: "RouterJobOffer.getExpiresAt()"
|
||||
summary: "Get the expires<wbr>At property: Timestamp when the offer will expire in UTC."
|
||||
syntax: "public OffsetDateTime getExpiresAt()"
|
||||
desc: "Get the expiresAt property: Timestamp when the offer will expire in UTC."
|
||||
returns:
|
||||
description: "the expiresAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobOffer.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "RouterJobOffer.getJobId()"
|
||||
summary: "Get the job<wbr>Id property: Id of the job."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get the jobId property: Id of the job."
|
||||
returns:
|
||||
description: "the jobId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobOffer.getOfferId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer.getOfferId()"
|
||||
name: "getOfferId()"
|
||||
nameWithType: "RouterJobOffer.getOfferId()"
|
||||
summary: "Get the offer<wbr>Id property: Id of an offer."
|
||||
syntax: "public String getOfferId()"
|
||||
desc: "Get the offerId property: Id of an offer."
|
||||
returns:
|
||||
description: "the offerId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobOffer.getOfferedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobOffer.getOfferedAt()"
|
||||
name: "getOfferedAt()"
|
||||
nameWithType: "RouterJobOffer.getOfferedAt()"
|
||||
summary: "Get the offered<wbr>At property: Timestamp when the offer was created in UTC."
|
||||
syntax: "public OffsetDateTime getOfferedAt()"
|
||||
desc: "Get the offeredAt property: Timestamp when the offer was created in UTC."
|
||||
returns:
|
||||
description: "the offeredAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
type: "class"
|
||||
desc: "An offer of a job to a worker."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails"
|
||||
name: "RouterJobPositionDetails"
|
||||
nameWithType: "RouterJobPositionDetails"
|
||||
summary: "Position and estimated wait time for a job."
|
||||
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 **RouterJobPositionDetails**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getEstimatedWaitTimeMinutes()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getEstimatedWaitTimeMinutes()"
|
||||
name: "getEstimatedWaitTimeMinutes()"
|
||||
nameWithType: "RouterJobPositionDetails.getEstimatedWaitTimeMinutes()"
|
||||
summary: "Get the estimated<wbr>Wait<wbr>Time<wbr>Minutes property: Estimated wait time of the job rounded up to the nearest minute."
|
||||
syntax: "public double getEstimatedWaitTimeMinutes()"
|
||||
desc: "Get the estimatedWaitTimeMinutes property: Estimated wait time of the job rounded up to the nearest minute."
|
||||
returns:
|
||||
description: "the estimatedWaitTimeMinutes value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "RouterJobPositionDetails.getJobId()"
|
||||
summary: "Get the job<wbr>Id property: Id of the job these details are about."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get the jobId property: Id of the job these details are about."
|
||||
returns:
|
||||
description: "the jobId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getPosition()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getPosition()"
|
||||
name: "getPosition()"
|
||||
nameWithType: "RouterJobPositionDetails.getPosition()"
|
||||
summary: "Get the position property: Position of the job in question within that queue."
|
||||
syntax: "public int getPosition()"
|
||||
desc: "Get the position property: Position of the job in question within that queue."
|
||||
returns:
|
||||
description: "the position value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "RouterJobPositionDetails.getQueueId()"
|
||||
summary: "Get the queue<wbr>Id property: Id of the queue this job is enqueued in."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Get the queueId property: Id of the queue this job is enqueued in."
|
||||
returns:
|
||||
description: "the queueId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getQueueLength()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobPositionDetails.getQueueLength()"
|
||||
name: "getQueueLength()"
|
||||
nameWithType: "RouterJobPositionDetails.getQueueLength()"
|
||||
summary: "Get the queue<wbr>Length property: Length of the queue: total number of enqueued jobs."
|
||||
syntax: "public int getQueueLength()"
|
||||
desc: "Get the queueLength property: Length of the queue: total number of enqueued jobs."
|
||||
returns:
|
||||
description: "the queueLength value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Position and estimated wait time for a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,217 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobStatus"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus"
|
||||
name: "RouterJobStatus"
|
||||
nameWithType: "RouterJobStatus"
|
||||
summary: "Describes the various status of a job."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **RouterJobStatus**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.RouterJobStatus()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.RouterJobStatus()"
|
||||
name: "RouterJobStatus()"
|
||||
nameWithType: "RouterJobStatus.RouterJobStatus()"
|
||||
summary: "Creates a new instance of Router<wbr>Job<wbr>Status value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.RouterJobStatus.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public RouterJobStatus()"
|
||||
desc: "Creates a new instance of RouterJobStatus value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.ASSIGNED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.ASSIGNED"
|
||||
name: "ASSIGNED"
|
||||
nameWithType: "RouterJobStatus.ASSIGNED"
|
||||
summary: "Job has been assigned to a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus ASSIGNED"
|
||||
desc: "Job has been assigned to a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.CANCELLED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.CANCELLED"
|
||||
name: "CANCELLED"
|
||||
nameWithType: "RouterJobStatus.CANCELLED"
|
||||
summary: "Job has been cancelled."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus CANCELLED"
|
||||
desc: "Job has been cancelled."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.CLASSIFICATION_FAILED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.CLASSIFICATION_FAILED"
|
||||
name: "CLASSIFICATION_FAILED"
|
||||
nameWithType: "RouterJobStatus.CLASSIFICATION_FAILED"
|
||||
summary: "Classification process failed for the job."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus CLASSIFICATION_FAILED"
|
||||
desc: "Classification process failed for the job."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.CLOSED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.CLOSED"
|
||||
name: "CLOSED"
|
||||
nameWithType: "RouterJobStatus.CLOSED"
|
||||
summary: "Job has been closed by a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus CLOSED"
|
||||
desc: "Job has been closed by a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.COMPLETED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.COMPLETED"
|
||||
name: "COMPLETED"
|
||||
nameWithType: "RouterJobStatus.COMPLETED"
|
||||
summary: "Job has been completed by a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus COMPLETED"
|
||||
desc: "Job has been completed by a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.CREATED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.CREATED"
|
||||
name: "CREATED"
|
||||
nameWithType: "RouterJobStatus.CREATED"
|
||||
summary: "Job has been created."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus CREATED"
|
||||
desc: "Job has been created."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.PENDING_CLASSIFICATION"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.PENDING_CLASSIFICATION"
|
||||
name: "PENDING_CLASSIFICATION"
|
||||
nameWithType: "RouterJobStatus.PENDING_CLASSIFICATION"
|
||||
summary: "Job is waiting to be classified."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus PENDING_CLASSIFICATION"
|
||||
desc: "Job is waiting to be classified."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.PENDING_SCHEDULE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.PENDING_SCHEDULE"
|
||||
name: "PENDING_SCHEDULE"
|
||||
nameWithType: "RouterJobStatus.PENDING_SCHEDULE"
|
||||
summary: "Job has been created but not been scheduled yet."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus PENDING_SCHEDULE"
|
||||
desc: "Job has been created but not been scheduled yet."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.QUEUED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.QUEUED"
|
||||
name: "QUEUED"
|
||||
nameWithType: "RouterJobStatus.QUEUED"
|
||||
summary: "Job has been queued."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus QUEUED"
|
||||
desc: "Job has been queued."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.SCHEDULED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.SCHEDULED"
|
||||
name: "SCHEDULED"
|
||||
nameWithType: "RouterJobStatus.SCHEDULED"
|
||||
summary: "Job has been scheduled successfully."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus SCHEDULED"
|
||||
desc: "Job has been scheduled successfully."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.SCHEDULE_FAILED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.SCHEDULE_FAILED"
|
||||
name: "SCHEDULE_FAILED"
|
||||
nameWithType: "RouterJobStatus.SCHEDULE_FAILED"
|
||||
summary: "Job scheduling failed."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus SCHEDULE_FAILED"
|
||||
desc: "Job scheduling failed."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.WAITING_FOR_ACTIVATION"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.WAITING_FOR_ACTIVATION"
|
||||
name: "WAITING_FOR_ACTIVATION"
|
||||
nameWithType: "RouterJobStatus.WAITING_FOR_ACTIVATION"
|
||||
summary: "Job is in a suspended state and waiting for an update."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatus WAITING_FOR_ACTIVATION"
|
||||
desc: "Job is in a suspended state and waiting for an update."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "RouterJobStatus.fromString(String name)"
|
||||
summary: "Creates or finds a Router<wbr>Job<wbr>Status from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static RouterJobStatus fromString(String name)"
|
||||
desc: "Creates or finds a RouterJobStatus from its string representation."
|
||||
returns:
|
||||
description: "the corresponding RouterJobStatus."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatus.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatus.values()"
|
||||
name: "values()"
|
||||
nameWithType: "RouterJobStatus.values()"
|
||||
summary: "Gets known Router<wbr>Job<wbr>Status values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<RouterJobStatus> values()"
|
||||
desc: "Gets known RouterJobStatus values."
|
||||
returns:
|
||||
description: "known RouterJobStatus values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatus?alt=com.azure.communication.jobrouter.models.RouterJobStatus&text=RouterJobStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes the various status of a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector"
|
||||
name: "RouterJobStatusSelector"
|
||||
nameWithType: "RouterJobStatusSelector"
|
||||
summary: "Enums used to filters jobs by status."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **RouterJobStatusSelector**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.RouterJobStatusSelector()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.RouterJobStatusSelector()"
|
||||
name: "RouterJobStatusSelector()"
|
||||
nameWithType: "RouterJobStatusSelector.RouterJobStatusSelector()"
|
||||
summary: "Creates a new instance of Router<wbr>Job<wbr>Status<wbr>Selector value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public RouterJobStatusSelector()"
|
||||
desc: "Creates a new instance of RouterJobStatusSelector value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ACTIVE"
|
||||
name: "ACTIVE"
|
||||
nameWithType: "RouterJobStatusSelector.ACTIVE"
|
||||
summary: "Job is in a state of Pending<wbr>Classification or Queued or Assigned or Classification<wbr>Failed or Completed or Pending<wbr>Schedule or Scheduled or Schedule<wbr>Failed or Waiting<wbr>For<wbr>Activation."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector ACTIVE"
|
||||
desc: "Job is in a state of PendingClassification or Queued or Assigned or ClassificationFailed or Completed or PendingSchedule or Scheduled or ScheduleFailed or WaitingForActivation."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ALL"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ALL"
|
||||
name: "ALL"
|
||||
nameWithType: "RouterJobStatusSelector.ALL"
|
||||
summary: "Default."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector ALL"
|
||||
desc: "Default."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ASSIGNED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.ASSIGNED"
|
||||
name: "ASSIGNED"
|
||||
nameWithType: "RouterJobStatusSelector.ASSIGNED"
|
||||
summary: "Job has been assigned to a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector ASSIGNED"
|
||||
desc: "Job has been assigned to a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CANCELLED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CANCELLED"
|
||||
name: "CANCELLED"
|
||||
nameWithType: "RouterJobStatusSelector.CANCELLED"
|
||||
summary: "Job has been cancelled."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector CANCELLED"
|
||||
desc: "Job has been cancelled."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CLASSIFICATION_FAILED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CLASSIFICATION_FAILED"
|
||||
name: "CLASSIFICATION_FAILED"
|
||||
nameWithType: "RouterJobStatusSelector.CLASSIFICATION_FAILED"
|
||||
summary: "Classification process failed for the job."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector CLASSIFICATION_FAILED"
|
||||
desc: "Classification process failed for the job."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CLOSED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CLOSED"
|
||||
name: "CLOSED"
|
||||
nameWithType: "RouterJobStatusSelector.CLOSED"
|
||||
summary: "Job has been closed by a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector CLOSED"
|
||||
desc: "Job has been closed by a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.COMPLETED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.COMPLETED"
|
||||
name: "COMPLETED"
|
||||
nameWithType: "RouterJobStatusSelector.COMPLETED"
|
||||
summary: "Job has been completed by a worker."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector COMPLETED"
|
||||
desc: "Job has been completed by a worker."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CREATED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.CREATED"
|
||||
name: "CREATED"
|
||||
nameWithType: "RouterJobStatusSelector.CREATED"
|
||||
summary: "Job has been created."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector CREATED"
|
||||
desc: "Job has been created."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.PENDING_CLASSIFICATION"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.PENDING_CLASSIFICATION"
|
||||
name: "PENDING_CLASSIFICATION"
|
||||
nameWithType: "RouterJobStatusSelector.PENDING_CLASSIFICATION"
|
||||
summary: "Job is waiting to be classified."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector PENDING_CLASSIFICATION"
|
||||
desc: "Job is waiting to be classified."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.PENDING_SCHEDULE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.PENDING_SCHEDULE"
|
||||
name: "PENDING_SCHEDULE"
|
||||
nameWithType: "RouterJobStatusSelector.PENDING_SCHEDULE"
|
||||
summary: "Job has been created but not been scheduled yet."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector PENDING_SCHEDULE"
|
||||
desc: "Job has been created but not been scheduled yet."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.QUEUED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.QUEUED"
|
||||
name: "QUEUED"
|
||||
nameWithType: "RouterJobStatusSelector.QUEUED"
|
||||
summary: "Job has been queued."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector QUEUED"
|
||||
desc: "Job has been queued."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.SCHEDULED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.SCHEDULED"
|
||||
name: "SCHEDULED"
|
||||
nameWithType: "RouterJobStatusSelector.SCHEDULED"
|
||||
summary: "Job has been scheduled successfully."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector SCHEDULED"
|
||||
desc: "Job has been scheduled successfully."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.SCHEDULE_FAILED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.SCHEDULE_FAILED"
|
||||
name: "SCHEDULE_FAILED"
|
||||
nameWithType: "RouterJobStatusSelector.SCHEDULE_FAILED"
|
||||
summary: "Job scheduling failed."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector SCHEDULE_FAILED"
|
||||
desc: "Job scheduling failed."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.WAITING_FOR_ACTIVATION"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.WAITING_FOR_ACTIVATION"
|
||||
name: "WAITING_FOR_ACTIVATION"
|
||||
nameWithType: "RouterJobStatusSelector.WAITING_FOR_ACTIVATION"
|
||||
summary: "Job is in a suspended state and waiting for an update."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterJobStatusSelector WAITING_FOR_ACTIVATION"
|
||||
desc: "Job is in a suspended state and waiting for an update."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "RouterJobStatusSelector.fromString(String name)"
|
||||
summary: "Creates or finds a Router<wbr>Job<wbr>Status<wbr>Selector from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static RouterJobStatusSelector fromString(String name)"
|
||||
desc: "Creates or finds a RouterJobStatusSelector from its string representation."
|
||||
returns:
|
||||
description: "the corresponding RouterJobStatusSelector."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterJobStatusSelector.values()"
|
||||
name: "values()"
|
||||
nameWithType: "RouterJobStatusSelector.values()"
|
||||
summary: "Gets known Router<wbr>Job<wbr>Status<wbr>Selector values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<RouterJobStatusSelector> values()"
|
||||
desc: "Gets known RouterJobStatusSelector values."
|
||||
returns:
|
||||
description: "known RouterJobStatusSelector values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobStatusSelector?alt=com.azure.communication.jobrouter.models.RouterJobStatusSelector&text=RouterJobStatusSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Enums used to filters jobs by status."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,153 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterQueue"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue"
|
||||
name: "RouterQueue"
|
||||
nameWithType: "RouterQueue"
|
||||
summary: "A queue that can contain jobs to be routed."
|
||||
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 **RouterQueue**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.RouterQueue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.RouterQueue()"
|
||||
name: "RouterQueue()"
|
||||
nameWithType: "RouterQueue.RouterQueue()"
|
||||
summary: "Creates an instance of Router<wbr>Queue class."
|
||||
syntax: "public RouterQueue()"
|
||||
desc: "Creates an instance of RouterQueue class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getDistributionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getDistributionPolicyId()"
|
||||
name: "getDistributionPolicyId()"
|
||||
nameWithType: "RouterQueue.getDistributionPolicyId()"
|
||||
summary: "Get the distribution<wbr>Policy<wbr>Id property: The ID of the distribution policy that will determine how a job is distributed to workers."
|
||||
syntax: "public String getDistributionPolicyId()"
|
||||
desc: "Get the distributionPolicyId property: The ID of the distribution policy that will determine how a job is distributed to workers."
|
||||
returns:
|
||||
description: "the distributionPolicyId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "RouterQueue.getEtag()"
|
||||
summary: "Get the etag property: Concurrency Token."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: Concurrency Token."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getExceptionPolicyId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getExceptionPolicyId()"
|
||||
name: "getExceptionPolicyId()"
|
||||
nameWithType: "RouterQueue.getExceptionPolicyId()"
|
||||
summary: "Get the exception<wbr>Policy<wbr>Id property: (Optional) The ID of the exception policy that determines various job escalation rules."
|
||||
syntax: "public String getExceptionPolicyId()"
|
||||
desc: "Get the exceptionPolicyId property: (Optional) The ID of the exception policy that determines various job escalation rules."
|
||||
returns:
|
||||
description: "the exceptionPolicyId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "RouterQueue.getId()"
|
||||
summary: "Get the id property: The Id of this queue."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: The Id of this queue."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "RouterQueue.getLabels()"
|
||||
summary: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the labels value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.getName()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.getName()"
|
||||
name: "getName()"
|
||||
nameWithType: "RouterQueue.getName()"
|
||||
summary: "Get the name property: The name of this queue."
|
||||
syntax: "public String getName()"
|
||||
desc: "Get the name property: The name of this queue."
|
||||
returns:
|
||||
description: "the name value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.setDistributionPolicyId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.setDistributionPolicyId(String distributionPolicyId)"
|
||||
name: "setDistributionPolicyId(String distributionPolicyId)"
|
||||
nameWithType: "RouterQueue.setDistributionPolicyId(String distributionPolicyId)"
|
||||
summary: "Set the distribution<wbr>Policy<wbr>Id property: The ID of the distribution policy that will determine how a job is distributed to workers."
|
||||
parameters:
|
||||
- description: "the distributionPolicyId value to set."
|
||||
name: "distributionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterQueue setDistributionPolicyId(String distributionPolicyId)"
|
||||
desc: "Set the distributionPolicyId property: The ID of the distribution policy that will determine how a job is distributed to workers."
|
||||
returns:
|
||||
description: "the RouterQueue object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.setExceptionPolicyId(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.setExceptionPolicyId(String exceptionPolicyId)"
|
||||
name: "setExceptionPolicyId(String exceptionPolicyId)"
|
||||
nameWithType: "RouterQueue.setExceptionPolicyId(String exceptionPolicyId)"
|
||||
summary: "Set the exception<wbr>Policy<wbr>Id property: (Optional) The ID of the exception policy that determines various job escalation rules."
|
||||
parameters:
|
||||
- description: "the exceptionPolicyId value to set."
|
||||
name: "exceptionPolicyId"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterQueue setExceptionPolicyId(String exceptionPolicyId)"
|
||||
desc: "Set the exceptionPolicyId property: (Optional) The ID of the exception policy that determines various job escalation rules."
|
||||
returns:
|
||||
description: "the RouterQueue object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "RouterQueue.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
parameters:
|
||||
- description: "the labels value to set."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterQueue setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the RouterQueue object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueue.setName(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueue.setName(String name)"
|
||||
name: "setName(String name)"
|
||||
nameWithType: "RouterQueue.setName(String name)"
|
||||
summary: "Set the name property: The name of this queue."
|
||||
parameters:
|
||||
- description: "the name value to set."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterQueue setName(String name)"
|
||||
desc: "Set the name property: The name of this queue."
|
||||
returns:
|
||||
description: "the RouterQueue object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueue?alt=com.azure.communication.jobrouter.models.RouterQueue&text=RouterQueue\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A queue that can contain jobs to be routed."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterQueueSelector"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector"
|
||||
name: "RouterQueueSelector"
|
||||
nameWithType: "RouterQueueSelector"
|
||||
summary: "Describes a condition that must be met against a set of labels for queue selection."
|
||||
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 **RouterQueueSelector**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueSelector.RouterQueueSelector(java.lang.String,com.azure.communication.jobrouter.models.LabelOperator)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector.RouterQueueSelector(String key, LabelOperator labelOperator)"
|
||||
name: "RouterQueueSelector(String key, LabelOperator labelOperator)"
|
||||
nameWithType: "RouterQueueSelector.RouterQueueSelector(String key, LabelOperator labelOperator)"
|
||||
summary: "Creates an instance of Router<wbr>Queue<wbr>Selector class."
|
||||
parameters:
|
||||
- description: "the key value to set."
|
||||
name: "key"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the labelOperator value to set."
|
||||
name: "labelOperator"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterQueueSelector(String key, LabelOperator labelOperator)"
|
||||
desc: "Creates an instance of RouterQueueSelector class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueSelector.getKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector.getKey()"
|
||||
name: "getKey()"
|
||||
nameWithType: "RouterQueueSelector.getKey()"
|
||||
summary: "Get the key property: The label key to query against."
|
||||
syntax: "public String getKey()"
|
||||
desc: "Get the key property: The label key to query against."
|
||||
returns:
|
||||
description: "the key value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueSelector.getLabelOperator()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector.getLabelOperator()"
|
||||
name: "getLabelOperator()"
|
||||
nameWithType: "RouterQueueSelector.getLabelOperator()"
|
||||
summary: "Get the label<wbr>Operator property: Describes how the value of the label is compared to the value defined on the label selector."
|
||||
syntax: "public LabelOperator getLabelOperator()"
|
||||
desc: "Get the labelOperator property: Describes how the value of the label is compared to the value defined on the label selector."
|
||||
returns:
|
||||
description: "the labelOperator value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueSelector.getValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "RouterQueueSelector.getValue()"
|
||||
summary: "Get the value property: The value to compare against the actual label value with the given operator."
|
||||
syntax: "public RouterValue getValue()"
|
||||
desc: "Get the value property: The value to compare against the actual label value with the given operator."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueSelector.setValue(com.azure.communication.jobrouter.models.RouterValue)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueSelector.setValue(RouterValue value)"
|
||||
name: "setValue(RouterValue value)"
|
||||
nameWithType: "RouterQueueSelector.setValue(RouterValue value)"
|
||||
summary: "Set the value property: The value to compare against the actual label value with the given operator."
|
||||
parameters:
|
||||
- description: "the value value to set."
|
||||
name: "value"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterQueueSelector setValue(RouterValue value)"
|
||||
desc: "Set the value property: The value to compare against the actual label value with the given operator."
|
||||
returns:
|
||||
description: "the RouterQueueSelector object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Describes a condition that must be met against a set of labels for queue selection."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterQueueStatistics"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueStatistics"
|
||||
name: "RouterQueueStatistics"
|
||||
nameWithType: "RouterQueueStatistics"
|
||||
summary: "Statistics for the queue."
|
||||
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 **RouterQueueStatistics**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getEstimatedWaitTime()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getEstimatedWaitTime()"
|
||||
name: "getEstimatedWaitTime()"
|
||||
nameWithType: "RouterQueueStatistics.getEstimatedWaitTime()"
|
||||
summary: "Get the estimated<wbr>Wait<wbr>Time<wbr>Minutes property: The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority."
|
||||
syntax: "public Map<Integer,Duration> getEstimatedWaitTime()"
|
||||
desc: "Get the estimatedWaitTimeMinutes property: The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority."
|
||||
returns:
|
||||
description: "the estimatedWaitTimeMinutes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getLength()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getLength()"
|
||||
name: "getLength()"
|
||||
nameWithType: "RouterQueueStatistics.getLength()"
|
||||
summary: "Get the length property: Length of the queue: total number of enqueued jobs."
|
||||
syntax: "public int getLength()"
|
||||
desc: "Get the length property: Length of the queue: total number of enqueued jobs."
|
||||
returns:
|
||||
description: "the length value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getLongestJobWaitTimeMinutes()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getLongestJobWaitTimeMinutes()"
|
||||
name: "getLongestJobWaitTimeMinutes()"
|
||||
nameWithType: "RouterQueueStatistics.getLongestJobWaitTimeMinutes()"
|
||||
summary: "Get the longest<wbr>Job<wbr>Wait<wbr>Time<wbr>Minutes property: The wait time of the job that has been enqueued in this queue for the longest."
|
||||
syntax: "public Double getLongestJobWaitTimeMinutes()"
|
||||
desc: "Get the longestJobWaitTimeMinutes property: The wait time of the job that has been enqueued in this queue for the longest."
|
||||
returns:
|
||||
description: "the longestJobWaitTimeMinutes value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getQueueId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterQueueStatistics.getQueueId()"
|
||||
name: "getQueueId()"
|
||||
nameWithType: "RouterQueueStatistics.getQueueId()"
|
||||
summary: "Get the queue<wbr>Id property: Id of the queue these details are about."
|
||||
syntax: "public String getQueueId()"
|
||||
desc: "Get the queueId property: Id of the queue these details are about."
|
||||
returns:
|
||||
description: "the queueId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Statistics for the queue."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterRule"
|
||||
name: "RouterRule"
|
||||
nameWithType: "RouterRule"
|
||||
summary: "A rule of one of the following types: Static<wbr>Rule: A rule providing static rules that always return the same result, regardless of input."
|
||||
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 abstract class **RouterRule**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterRule.RouterRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterRule.RouterRule()"
|
||||
name: "RouterRule()"
|
||||
nameWithType: "RouterRule.RouterRule()"
|
||||
summary: "Creates an instance of Router<wbr>Rule class."
|
||||
syntax: "public RouterRule()"
|
||||
desc: "Creates an instance of RouterRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterRule.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterRule.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "RouterRule.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "A rule of one of the following types: StaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,114 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterValue"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue"
|
||||
name: "RouterValue"
|
||||
nameWithType: "RouterValue"
|
||||
summary: "Wrapper class for labels."
|
||||
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 **RouterValue**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(Boolean boolValue)"
|
||||
name: "RouterValue(Boolean boolValue)"
|
||||
nameWithType: "RouterValue.RouterValue(Boolean boolValue)"
|
||||
summary: "Bool<wbr>Value constructor."
|
||||
parameters:
|
||||
- description: "boolValue"
|
||||
name: "boolValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public RouterValue(Boolean boolValue)"
|
||||
desc: "BoolValue constructor."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(java.lang.Double)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(Double doubleValue)"
|
||||
name: "RouterValue(Double doubleValue)"
|
||||
nameWithType: "RouterValue.RouterValue(Double doubleValue)"
|
||||
summary: "Double<wbr>Value constructor."
|
||||
parameters:
|
||||
- description: "doubleValue."
|
||||
name: "doubleValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
syntax: "public RouterValue(Double doubleValue)"
|
||||
desc: "DoubleValue constructor."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(Integer intValue)"
|
||||
name: "RouterValue(Integer intValue)"
|
||||
nameWithType: "RouterValue.RouterValue(Integer intValue)"
|
||||
summary: "Constructor for int<wbr>Value."
|
||||
parameters:
|
||||
- description: "intValue."
|
||||
name: "intValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RouterValue(Integer intValue)"
|
||||
desc: "Constructor for intValue."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.RouterValue(String stringValue)"
|
||||
name: "RouterValue(String stringValue)"
|
||||
nameWithType: "RouterValue.RouterValue(String stringValue)"
|
||||
summary: "String constructor."
|
||||
parameters:
|
||||
- description: "stringValue."
|
||||
name: "stringValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public RouterValue(String stringValue)"
|
||||
desc: "String constructor."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.getBooleanValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.getBooleanValue()"
|
||||
name: "getBooleanValue()"
|
||||
nameWithType: "RouterValue.getBooleanValue()"
|
||||
summary: "Returns bool<wbr>Value."
|
||||
syntax: "public Boolean getBooleanValue()"
|
||||
desc: "Returns boolValue."
|
||||
returns:
|
||||
description: "boolValue."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.getDoubleValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.getDoubleValue()"
|
||||
name: "getDoubleValue()"
|
||||
nameWithType: "RouterValue.getDoubleValue()"
|
||||
summary: "Returns double<wbr>Value."
|
||||
syntax: "public Double getDoubleValue()"
|
||||
desc: "Returns doubleValue."
|
||||
returns:
|
||||
description: "doubleValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.getIntValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.getIntValue()"
|
||||
name: "getIntValue()"
|
||||
nameWithType: "RouterValue.getIntValue()"
|
||||
summary: "Returns int<wbr>Value."
|
||||
syntax: "public Integer getIntValue()"
|
||||
desc: "Returns intValue."
|
||||
returns:
|
||||
description: "intValue"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterValue.getStringValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterValue.getStringValue()"
|
||||
name: "getStringValue()"
|
||||
nameWithType: "RouterValue.getStringValue()"
|
||||
summary: "Returns string<wbr>Value"
|
||||
syntax: "public String getStringValue()"
|
||||
desc: "Returns stringValue"
|
||||
returns:
|
||||
description: "stringValue."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "Wrapper class for labels. Supports String, int, double and boolean types. If multiple values are set only one value will be used with following precedence. 1. stringValue. 2. intValue. 3. doubleValue. 4. boolValue."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,241 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorker"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker"
|
||||
name: "RouterWorker"
|
||||
nameWithType: "RouterWorker"
|
||||
summary: "An entity for jobs to be routed to."
|
||||
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 **RouterWorker**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.RouterWorker()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.RouterWorker()"
|
||||
name: "RouterWorker()"
|
||||
nameWithType: "RouterWorker.RouterWorker()"
|
||||
summary: "Creates an instance of Router<wbr>Worker class."
|
||||
syntax: "public RouterWorker()"
|
||||
desc: "Creates an instance of RouterWorker class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getAssignedJobs()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getAssignedJobs()"
|
||||
name: "getAssignedJobs()"
|
||||
nameWithType: "RouterWorker.getAssignedJobs()"
|
||||
summary: "Get the assigned<wbr>Jobs property: A list of assigned jobs attached to this worker."
|
||||
syntax: "public List<RouterWorkerAssignment> getAssignedJobs()"
|
||||
desc: "Get the assignedJobs property: A list of assigned jobs attached to this worker."
|
||||
returns:
|
||||
description: "the assignedJobs value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerAssignment?alt=com.azure.communication.jobrouter.models.RouterWorkerAssignment&text=RouterWorkerAssignment\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getCapacity()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getCapacity()"
|
||||
name: "getCapacity()"
|
||||
nameWithType: "RouterWorker.getCapacity()"
|
||||
summary: "Get the capacity property: The total capacity score this worker has to manage multiple concurrent jobs."
|
||||
syntax: "public Integer getCapacity()"
|
||||
desc: "Get the capacity property: The total capacity score this worker has to manage multiple concurrent jobs."
|
||||
returns:
|
||||
description: "the capacity value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getChannels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getChannels()"
|
||||
name: "getChannels()"
|
||||
nameWithType: "RouterWorker.getChannels()"
|
||||
summary: "Get the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
syntax: "public List<RouterChannel> getChannels()"
|
||||
desc: "Get the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
returns:
|
||||
description: "the channels value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterChannel?alt=com.azure.communication.jobrouter.models.RouterChannel&text=RouterChannel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getEtag()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getEtag()"
|
||||
name: "getEtag()"
|
||||
nameWithType: "RouterWorker.getEtag()"
|
||||
summary: "Get the etag property: Concurrency Token."
|
||||
syntax: "public String getEtag()"
|
||||
desc: "Get the etag property: Concurrency Token."
|
||||
returns:
|
||||
description: "the etag value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getId()"
|
||||
name: "getId()"
|
||||
nameWithType: "RouterWorker.getId()"
|
||||
summary: "Get the id property: Id of the worker."
|
||||
syntax: "public String getId()"
|
||||
desc: "Get the id property: Id of the worker."
|
||||
returns:
|
||||
description: "the id value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getLabels()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getLabels()"
|
||||
name: "getLabels()"
|
||||
nameWithType: "RouterWorker.getLabels()"
|
||||
summary: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
syntax: "public Map<String,RouterValue> getLabels()"
|
||||
desc: "Get the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the labels value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getLoadRatio()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getLoadRatio()"
|
||||
name: "getLoadRatio()"
|
||||
nameWithType: "RouterWorker.getLoadRatio()"
|
||||
summary: "Get the load<wbr>Ratio property: A value indicating the workers capacity."
|
||||
syntax: "public Double getLoadRatio()"
|
||||
desc: "Get the loadRatio property: A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed."
|
||||
returns:
|
||||
description: "the loadRatio value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getOffers()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getOffers()"
|
||||
name: "getOffers()"
|
||||
nameWithType: "RouterWorker.getOffers()"
|
||||
summary: "Get the offers property: A list of active offers issued to this worker."
|
||||
syntax: "public List<RouterJobOffer> getOffers()"
|
||||
desc: "Get the offers property: A list of active offers issued to this worker."
|
||||
returns:
|
||||
description: "the offers value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterJobOffer?alt=com.azure.communication.jobrouter.models.RouterJobOffer&text=RouterJobOffer\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getQueues()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getQueues()"
|
||||
name: "getQueues()"
|
||||
nameWithType: "RouterWorker.getQueues()"
|
||||
summary: "Get the queues property: The queue(s) that this worker can receive work from."
|
||||
syntax: "public List<String> getQueues()"
|
||||
desc: "Get the queues property: The queue(s) that this worker can receive work from."
|
||||
returns:
|
||||
description: "the queues value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getState()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getState()"
|
||||
name: "getState()"
|
||||
nameWithType: "RouterWorker.getState()"
|
||||
summary: "Get the state property: The current state of the worker."
|
||||
syntax: "public RouterWorkerState getState()"
|
||||
desc: "Get the state property: The current state of the worker."
|
||||
returns:
|
||||
description: "the state value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.getTags()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.getTags()"
|
||||
name: "getTags()"
|
||||
nameWithType: "RouterWorker.getTags()"
|
||||
summary: "Get the tags property: A set of non-identifying attributes attached to this worker."
|
||||
syntax: "public Map<String,RouterValue> getTags()"
|
||||
desc: "Get the tags property: A set of non-identifying attributes attached to this worker."
|
||||
returns:
|
||||
description: "the tags value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.isAvailableForOffers()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.isAvailableForOffers()"
|
||||
name: "isAvailableForOffers()"
|
||||
nameWithType: "RouterWorker.isAvailableForOffers()"
|
||||
summary: "Get the available<wbr>For<wbr>Offers property: A flag indicating this worker is open to receive offers or not."
|
||||
syntax: "public Boolean isAvailableForOffers()"
|
||||
desc: "Get the availableForOffers property: A flag indicating this worker is open to receive offers or not."
|
||||
returns:
|
||||
description: "the availableForOffers value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorker.setAvailableForOffers(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setAvailableForOffers(Boolean availableForOffers)"
|
||||
name: "setAvailableForOffers(Boolean availableForOffers)"
|
||||
nameWithType: "RouterWorker.setAvailableForOffers(Boolean availableForOffers)"
|
||||
summary: "Set the available<wbr>For<wbr>Offers property: A flag indicating this worker is open to receive offers or not."
|
||||
parameters:
|
||||
- description: "the availableForOffers value to set."
|
||||
name: "availableForOffers"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public RouterWorker setAvailableForOffers(Boolean availableForOffers)"
|
||||
desc: "Set the availableForOffers property: A flag indicating this worker is open to receive offers or not."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<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.models.RouterWorker.setCapacity(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setCapacity(Integer capacity)"
|
||||
name: "setCapacity(Integer capacity)"
|
||||
nameWithType: "RouterWorker.setCapacity(Integer capacity)"
|
||||
summary: "Set the capacity property: The total capacity score this worker has to manage multiple concurrent jobs."
|
||||
parameters:
|
||||
- description: "the capacity value to set."
|
||||
name: "capacity"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public RouterWorker setCapacity(Integer capacity)"
|
||||
desc: "Set the capacity property: The total capacity score this worker has to manage multiple concurrent jobs."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<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.models.RouterWorker.setChannels(java.util.List<com.azure.communication.jobrouter.models.RouterChannel>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setChannels(List<RouterChannel> channels)"
|
||||
name: "setChannels(List<RouterChannel> channels)"
|
||||
nameWithType: "RouterWorker.setChannels(List<RouterChannel> channels)"
|
||||
summary: "Set the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
parameters:
|
||||
- description: "the channels value to set."
|
||||
name: "channels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterChannel?alt=com.azure.communication.jobrouter.models.RouterChannel&text=RouterChannel\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterWorker setChannels(List<RouterChannel> channels)"
|
||||
desc: "Set the channels property: The channel(s) this worker can handle and their impact on the workers capacity."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<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.models.RouterWorker.setLabels(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setLabels(Map<String,RouterValue> labels)"
|
||||
name: "setLabels(Map<String,RouterValue> labels)"
|
||||
nameWithType: "RouterWorker.setLabels(Map<String,RouterValue> labels)"
|
||||
summary: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
parameters:
|
||||
- description: "the labels value to set."
|
||||
name: "labels"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterWorker setLabels(Map<String,RouterValue> labels)"
|
||||
desc: "Set the labels property: A set of key/value pairs that are identifying attributes used by the rules engines to make decisions."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<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.models.RouterWorker.setQueues(java.util.List<java.lang.String>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setQueues(List<String> queues)"
|
||||
name: "setQueues(List<String> queues)"
|
||||
nameWithType: "RouterWorker.setQueues(List<String> queues)"
|
||||
summary: "Set the queues property: The queue(s) that this worker can receive work from."
|
||||
parameters:
|
||||
- description: "the queues value to set."
|
||||
name: "queues"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
||||
syntax: "public RouterWorker setQueues(List<String> queues)"
|
||||
desc: "Set the queues property: The queue(s) that this worker can receive work from."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<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.models.RouterWorker.setTags(java.util.Map<java.lang.String,com.azure.communication.jobrouter.models.RouterValue>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorker.setTags(Map<String,RouterValue> tags)"
|
||||
name: "setTags(Map<String,RouterValue> tags)"
|
||||
nameWithType: "RouterWorker.setTags(Map<String,RouterValue> tags)"
|
||||
summary: "Set the tags property: A set of non-identifying attributes attached to this worker."
|
||||
parameters:
|
||||
- description: "the tags value to set."
|
||||
name: "tags"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public RouterWorker setTags(Map<String,RouterValue> tags)"
|
||||
desc: "Set the tags property: A set of non-identifying attributes attached to this worker."
|
||||
returns:
|
||||
description: "the RouterWorker object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorker?alt=com.azure.communication.jobrouter.models.RouterWorker&text=RouterWorker\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "An entity for jobs to be routed to."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorkerAssignment"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerAssignment"
|
||||
name: "RouterWorkerAssignment"
|
||||
nameWithType: "RouterWorkerAssignment"
|
||||
summary: "The assignment for a worker to a job."
|
||||
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 **RouterWorkerAssignment**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getAssignedAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getAssignedAt()"
|
||||
name: "getAssignedAt()"
|
||||
nameWithType: "RouterWorkerAssignment.getAssignedAt()"
|
||||
summary: "Get the assigned<wbr>At property: The assignment time of the job in UTC."
|
||||
syntax: "public OffsetDateTime getAssignedAt()"
|
||||
desc: "Get the assignedAt property: The assignment time of the job in UTC."
|
||||
returns:
|
||||
description: "the assignedAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getAssignmentId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getAssignmentId()"
|
||||
name: "getAssignmentId()"
|
||||
nameWithType: "RouterWorkerAssignment.getAssignmentId()"
|
||||
summary: "Get the assignment<wbr>Id property: Id of the assignment."
|
||||
syntax: "public String getAssignmentId()"
|
||||
desc: "Get the assignmentId property: Id of the assignment."
|
||||
returns:
|
||||
description: "the assignmentId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getCapacityCost()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getCapacityCost()"
|
||||
name: "getCapacityCost()"
|
||||
nameWithType: "RouterWorkerAssignment.getCapacityCost()"
|
||||
summary: "Get the capacity<wbr>Cost property: The amount of capacity this assignment has consumed on the worker."
|
||||
syntax: "public int getCapacityCost()"
|
||||
desc: "Get the capacityCost property: The amount of capacity this assignment has consumed on the worker."
|
||||
returns:
|
||||
description: "the capacityCost value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerAssignment.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "RouterWorkerAssignment.getJobId()"
|
||||
summary: "Get the job<wbr>Id property: Id of the job assigned."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get the jobId property: Id of the job assigned."
|
||||
returns:
|
||||
description: "the jobId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "The assignment for a worker to a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,156 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector"
|
||||
name: "RouterWorkerSelector"
|
||||
nameWithType: "RouterWorkerSelector"
|
||||
summary: "Describes a condition that must be met against a set of labels for worker selection."
|
||||
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 **RouterWorkerSelector**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.RouterWorkerSelector(java.lang.String,com.azure.communication.jobrouter.models.LabelOperator)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.RouterWorkerSelector(String key, LabelOperator labelOperator)"
|
||||
name: "RouterWorkerSelector(String key, LabelOperator labelOperator)"
|
||||
nameWithType: "RouterWorkerSelector.RouterWorkerSelector(String key, LabelOperator labelOperator)"
|
||||
summary: "Creates an instance of Router<wbr>Worker<wbr>Selector class."
|
||||
parameters:
|
||||
- description: "the key value to set."
|
||||
name: "key"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- description: "the labelOperator value to set."
|
||||
name: "labelOperator"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterWorkerSelector(String key, LabelOperator labelOperator)"
|
||||
desc: "Creates an instance of RouterWorkerSelector class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getExpiresAfter()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getExpiresAfter()"
|
||||
name: "getExpiresAfter()"
|
||||
nameWithType: "RouterWorkerSelector.getExpiresAfter()"
|
||||
summary: "Get the expires<wbr>After property: Describes how long this label selector is valid."
|
||||
syntax: "public Duration getExpiresAfter()"
|
||||
desc: "Get the expiresAfter property: Describes how long this label selector is valid."
|
||||
returns:
|
||||
description: "the expiresAfter value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getExpiresAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getExpiresAt()"
|
||||
name: "getExpiresAt()"
|
||||
nameWithType: "RouterWorkerSelector.getExpiresAt()"
|
||||
summary: "Get the expires<wbr>At property: The time at which this worker selector expires in UTC."
|
||||
syntax: "public OffsetDateTime getExpiresAt()"
|
||||
desc: "Get the expiresAt property: The time at which this worker selector expires in UTC."
|
||||
returns:
|
||||
description: "the expiresAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getKey()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getKey()"
|
||||
name: "getKey()"
|
||||
nameWithType: "RouterWorkerSelector.getKey()"
|
||||
summary: "Get the key property: The label key to query against."
|
||||
syntax: "public String getKey()"
|
||||
desc: "Get the key property: The label key to query against."
|
||||
returns:
|
||||
description: "the key value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getLabelOperator()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getLabelOperator()"
|
||||
name: "getLabelOperator()"
|
||||
nameWithType: "RouterWorkerSelector.getLabelOperator()"
|
||||
summary: "Get the label<wbr>Operator property: Describes how the value of the label is compared to the value defined on the label selector."
|
||||
syntax: "public LabelOperator getLabelOperator()"
|
||||
desc: "Get the labelOperator property: Describes how the value of the label is compared to the value defined on the label selector."
|
||||
returns:
|
||||
description: "the labelOperator value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.LabelOperator?alt=com.azure.communication.jobrouter.models.LabelOperator&text=LabelOperator\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getStatus()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getStatus()"
|
||||
name: "getStatus()"
|
||||
nameWithType: "RouterWorkerSelector.getStatus()"
|
||||
summary: "Get the status property: The status of the worker selector."
|
||||
syntax: "public RouterWorkerSelectorStatus getStatus()"
|
||||
desc: "Get the status property: The status of the worker selector."
|
||||
returns:
|
||||
description: "the status value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "RouterWorkerSelector.getValue()"
|
||||
summary: "Get the value property: The value to compare against the actual label value with the given operator."
|
||||
syntax: "public RouterValue getValue()"
|
||||
desc: "Get the value property: The value to compare against the actual label value with the given operator."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.isExpedite()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.isExpedite()"
|
||||
name: "isExpedite()"
|
||||
nameWithType: "RouterWorkerSelector.isExpedite()"
|
||||
summary: "Get the expedite property: Pushes the job to the front of the queue as long as this selector is active."
|
||||
syntax: "public Boolean isExpedite()"
|
||||
desc: "Get the expedite property: Pushes the job to the front of the queue as long as this selector is active."
|
||||
returns:
|
||||
description: "the expedite value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setExpedite(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setExpedite(Boolean expedite)"
|
||||
name: "setExpedite(Boolean expedite)"
|
||||
nameWithType: "RouterWorkerSelector.setExpedite(Boolean expedite)"
|
||||
summary: "Set the expedite property: Pushes the job to the front of the queue as long as this selector is active."
|
||||
parameters:
|
||||
- description: "the expedite value to set."
|
||||
name: "expedite"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public RouterWorkerSelector setExpedite(Boolean expedite)"
|
||||
desc: "Set the expedite property: Pushes the job to the front of the queue as long as this selector is active."
|
||||
returns:
|
||||
description: "the RouterWorkerSelector object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setExpiresAfter(java.time.Duration)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setExpiresAfter(Duration expiresAfter)"
|
||||
name: "setExpiresAfter(Duration expiresAfter)"
|
||||
nameWithType: "RouterWorkerSelector.setExpiresAfter(Duration expiresAfter)"
|
||||
summary: "Set the expires<wbr>After property: Describes how long this label selector is valid."
|
||||
parameters:
|
||||
- description: "the expiresAfter value to set."
|
||||
name: "expiresAfter"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
syntax: "public RouterWorkerSelector setExpiresAfter(Duration expiresAfter)"
|
||||
desc: "Set the expiresAfter property: Describes how long this label selector is valid."
|
||||
returns:
|
||||
description: "the RouterWorkerSelector object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setValue(com.azure.communication.jobrouter.models.RouterValue)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelector.setValue(RouterValue value)"
|
||||
name: "setValue(RouterValue value)"
|
||||
nameWithType: "RouterWorkerSelector.setValue(RouterValue value)"
|
||||
summary: "Set the value property: The value to compare against the actual label value with the given operator."
|
||||
parameters:
|
||||
- description: "the value value to set."
|
||||
name: "value"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RouterWorkerSelector setValue(RouterValue value)"
|
||||
desc: "Set the value property: The value to compare against the actual label value with the given operator."
|
||||
returns:
|
||||
description: "the RouterWorkerSelector object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Describes a condition that must be met against a set of labels for worker selection."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus"
|
||||
name: "RouterWorkerSelectorStatus"
|
||||
nameWithType: "RouterWorkerSelectorStatus"
|
||||
summary: "Describes the status of a worker selector."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **RouterWorkerSelectorStatus**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.RouterWorkerSelectorStatus()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.RouterWorkerSelectorStatus()"
|
||||
name: "RouterWorkerSelectorStatus()"
|
||||
nameWithType: "RouterWorkerSelectorStatus.RouterWorkerSelectorStatus()"
|
||||
summary: "Creates a new instance of Router<wbr>Worker<wbr>Selector<wbr>Status value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public RouterWorkerSelectorStatus()"
|
||||
desc: "Creates a new instance of RouterWorkerSelectorStatus value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.ACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.ACTIVE"
|
||||
name: "ACTIVE"
|
||||
nameWithType: "RouterWorkerSelectorStatus.ACTIVE"
|
||||
summary: "Worker selector is valid."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerSelectorStatus ACTIVE"
|
||||
desc: "Worker selector is valid."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.EXPIRED"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.EXPIRED"
|
||||
name: "EXPIRED"
|
||||
nameWithType: "RouterWorkerSelectorStatus.EXPIRED"
|
||||
summary: "Worker selector is not valid."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerSelectorStatus EXPIRED"
|
||||
desc: "Worker selector is not valid."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "RouterWorkerSelectorStatus.fromString(String name)"
|
||||
summary: "Creates or finds a Router<wbr>Worker<wbr>Selector<wbr>Status from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static RouterWorkerSelectorStatus fromString(String name)"
|
||||
desc: "Creates or finds a RouterWorkerSelectorStatus from its string representation."
|
||||
returns:
|
||||
description: "the corresponding RouterWorkerSelectorStatus."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus.values()"
|
||||
name: "values()"
|
||||
nameWithType: "RouterWorkerSelectorStatus.values()"
|
||||
summary: "Gets known Router<wbr>Worker<wbr>Selector<wbr>Status values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<RouterWorkerSelectorStatus> values()"
|
||||
desc: "Gets known RouterWorkerSelectorStatus values."
|
||||
returns:
|
||||
description: "known RouterWorkerSelectorStatus values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus?alt=com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus&text=RouterWorkerSelectorStatus\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes the status of a worker selector."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,109 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorkerState"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState"
|
||||
name: "RouterWorkerState"
|
||||
nameWithType: "RouterWorkerState"
|
||||
summary: "Enums for worker states."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **RouterWorkerState**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.RouterWorkerState()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.RouterWorkerState()"
|
||||
name: "RouterWorkerState()"
|
||||
nameWithType: "RouterWorkerState.RouterWorkerState()"
|
||||
summary: "Creates a new instance of Router<wbr>Worker<wbr>State value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.RouterWorkerState.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public RouterWorkerState()"
|
||||
desc: "Creates a new instance of RouterWorkerState value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.ACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.ACTIVE"
|
||||
name: "ACTIVE"
|
||||
nameWithType: "RouterWorkerState.ACTIVE"
|
||||
summary: "Worker is active and available to take offers."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerState ACTIVE"
|
||||
desc: "Worker is active and available to take offers."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.DRAINING"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.DRAINING"
|
||||
name: "DRAINING"
|
||||
nameWithType: "RouterWorkerState.DRAINING"
|
||||
summary: "Worker is not active, if there are existing offers they are being revoked."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerState DRAINING"
|
||||
desc: "Worker is not active, if there are existing offers they are being revoked. No new offers are sent."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.INACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.INACTIVE"
|
||||
name: "INACTIVE"
|
||||
nameWithType: "RouterWorkerState.INACTIVE"
|
||||
summary: "Worker is not active."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerState INACTIVE"
|
||||
desc: "Worker is not active. No new offers are sent."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "RouterWorkerState.fromString(String name)"
|
||||
summary: "Creates or finds a Router<wbr>Worker<wbr>State from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static RouterWorkerState fromString(String name)"
|
||||
desc: "Creates or finds a RouterWorkerState from its string representation."
|
||||
returns:
|
||||
description: "the corresponding RouterWorkerState."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerState.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerState.values()"
|
||||
name: "values()"
|
||||
nameWithType: "RouterWorkerState.values()"
|
||||
summary: "Gets known Router<wbr>Worker<wbr>State values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<RouterWorkerState> values()"
|
||||
desc: "Gets known RouterWorkerState values."
|
||||
returns:
|
||||
description: "known RouterWorkerState values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerState?alt=com.azure.communication.jobrouter.models.RouterWorkerState&text=RouterWorkerState\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Enums for worker states."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector"
|
||||
name: "RouterWorkerStateSelector"
|
||||
nameWithType: "RouterWorkerStateSelector"
|
||||
summary: "Enums used to filters workers by state."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **RouterWorkerStateSelector**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.RouterWorkerStateSelector()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.RouterWorkerStateSelector()"
|
||||
name: "RouterWorkerStateSelector()"
|
||||
nameWithType: "RouterWorkerStateSelector.RouterWorkerStateSelector()"
|
||||
summary: "Creates a new instance of Router<wbr>Worker<wbr>State<wbr>Selector value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public RouterWorkerStateSelector()"
|
||||
desc: "Creates a new instance of RouterWorkerStateSelector value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.ACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.ACTIVE"
|
||||
name: "ACTIVE"
|
||||
nameWithType: "RouterWorkerStateSelector.ACTIVE"
|
||||
summary: "Worker is active and available to take offers."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerStateSelector ACTIVE"
|
||||
desc: "Worker is active and available to take offers."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.ALL"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.ALL"
|
||||
name: "ALL"
|
||||
nameWithType: "RouterWorkerStateSelector.ALL"
|
||||
summary: "Worker is active or draining or inactive."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerStateSelector ALL"
|
||||
desc: "Worker is active or draining or inactive."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.DRAINING"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.DRAINING"
|
||||
name: "DRAINING"
|
||||
nameWithType: "RouterWorkerStateSelector.DRAINING"
|
||||
summary: "Worker is not active, if there are existing offers they are being revoked."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerStateSelector DRAINING"
|
||||
desc: "Worker is not active, if there are existing offers they are being revoked. No new offers are sent."
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.INACTIVE"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.INACTIVE"
|
||||
name: "INACTIVE"
|
||||
nameWithType: "RouterWorkerStateSelector.INACTIVE"
|
||||
summary: "Worker is not active."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final RouterWorkerStateSelector INACTIVE"
|
||||
desc: "Worker is not active. No new offers are sent."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "RouterWorkerStateSelector.fromString(String name)"
|
||||
summary: "Creates or finds a Router<wbr>Worker<wbr>State<wbr>Selector from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static RouterWorkerStateSelector fromString(String name)"
|
||||
desc: "Creates or finds a RouterWorkerStateSelector from its string representation."
|
||||
returns:
|
||||
description: "the corresponding RouterWorkerStateSelector."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RouterWorkerStateSelector.values()"
|
||||
name: "values()"
|
||||
nameWithType: "RouterWorkerStateSelector.values()"
|
||||
summary: "Gets known Router<wbr>Worker<wbr>State<wbr>Selector values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<RouterWorkerStateSelector> values()"
|
||||
desc: "Gets known RouterWorkerStateSelector values."
|
||||
returns:
|
||||
description: "known RouterWorkerStateSelector values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerStateSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerStateSelector&text=RouterWorkerStateSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Enums used to filters workers by state."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment"
|
||||
name: "RuleEngineQueueSelectorAttachment"
|
||||
nameWithType: "RuleEngineQueueSelectorAttachment"
|
||||
summary: "Attaches queue selectors to a job when the Router<wbr>Rule is resolved."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **RuleEngineQueueSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment.RuleEngineQueueSelectorAttachment(com.azure.communication.jobrouter.models.RouterRule)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment.RuleEngineQueueSelectorAttachment(RouterRule rule)"
|
||||
name: "RuleEngineQueueSelectorAttachment(RouterRule rule)"
|
||||
nameWithType: "RuleEngineQueueSelectorAttachment.RuleEngineQueueSelectorAttachment(RouterRule rule)"
|
||||
summary: "Creates an instance of Rule<wbr>Engine<wbr>Queue<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the rule value to set."
|
||||
name: "rule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RuleEngineQueueSelectorAttachment(RouterRule rule)"
|
||||
desc: "Creates an instance of RuleEngineQueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment.getRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment.getRule()"
|
||||
name: "getRule()"
|
||||
nameWithType: "RuleEngineQueueSelectorAttachment.getRule()"
|
||||
summary: "Get the rule property: A rule of one of the following types:"
|
||||
syntax: "public RouterRule getRule()"
|
||||
desc: "Get the rule property: A rule of one of the following types:\n\nStaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol."
|
||||
returns:
|
||||
description: "the rule value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Attaches queue selectors to a job when the RouterRule is resolved."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment"
|
||||
name: "RuleEngineWorkerSelectorAttachment"
|
||||
nameWithType: "RuleEngineWorkerSelectorAttachment"
|
||||
summary: "Attaches worker selectors to a job when a Router<wbr>Rule is resolved."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **RuleEngineWorkerSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment.RuleEngineWorkerSelectorAttachment(com.azure.communication.jobrouter.models.RouterRule)"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment.RuleEngineWorkerSelectorAttachment(RouterRule rule)"
|
||||
name: "RuleEngineWorkerSelectorAttachment(RouterRule rule)"
|
||||
nameWithType: "RuleEngineWorkerSelectorAttachment.RuleEngineWorkerSelectorAttachment(RouterRule rule)"
|
||||
summary: "Creates an instance of Rule<wbr>Engine<wbr>Worker<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the rule value to set."
|
||||
name: "rule"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public RuleEngineWorkerSelectorAttachment(RouterRule rule)"
|
||||
desc: "Creates an instance of RuleEngineWorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment.getRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment.getRule()"
|
||||
name: "getRule()"
|
||||
nameWithType: "RuleEngineWorkerSelectorAttachment.getRule()"
|
||||
summary: "Get the rule property: A rule of one of the following types:"
|
||||
syntax: "public RouterRule getRule()"
|
||||
desc: "Get the rule property: A rule of one of the following types:\n\nStaticRule: A rule providing static rules that always return the same result, regardless of input. DirectMapRule: A rule that return the same labels as the input labels. ExpressionRule: A rule providing inline expression rules. FunctionRule: A rule providing a binding to an HTTP Triggered Azure Function. WebhookRule: A rule providing a binding to a webserver following OAuth2.0 authentication protocol."
|
||||
returns:
|
||||
description: "the rule value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Attaches worker selectors to a job when a RouterRule is resolved."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode"
|
||||
name: "ScheduleAndSuspendMode"
|
||||
nameWithType: "ScheduleAndSuspendMode"
|
||||
summary: "Describes a matching mode used for scheduling jobs to be queued at a future time."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode.getKind()?alt=com.azure.communication.jobrouter.models.JobMatchingMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **ScheduleAndSuspendMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode.ScheduleAndSuspendMode(java.time.OffsetDateTime)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode.ScheduleAndSuspendMode(OffsetDateTime scheduleAt)"
|
||||
name: "ScheduleAndSuspendMode(OffsetDateTime scheduleAt)"
|
||||
nameWithType: "ScheduleAndSuspendMode.ScheduleAndSuspendMode(OffsetDateTime scheduleAt)"
|
||||
summary: "Creates an instance of Schedule<wbr>And<wbr>Suspend<wbr>Mode class."
|
||||
parameters:
|
||||
- description: "the scheduleAt value to set."
|
||||
name: "scheduleAt"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
syntax: "public ScheduleAndSuspendMode(OffsetDateTime scheduleAt)"
|
||||
desc: "Creates an instance of ScheduleAndSuspendMode class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode.getScheduleAt()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode.getScheduleAt()"
|
||||
name: "getScheduleAt()"
|
||||
nameWithType: "ScheduleAndSuspendMode.getScheduleAt()"
|
||||
summary: "Get the schedule<wbr>At property: Requested schedule time."
|
||||
syntax: "public OffsetDateTime getScheduleAt()"
|
||||
desc: "Get the scheduleAt property: Requested schedule time."
|
||||
returns:
|
||||
description: "the scheduleAt value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
||||
type: "class"
|
||||
desc: "Describes a matching mode used for scheduling jobs to be queued at a future time. At the specified time, matching worker to a job will not start automatically."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions"
|
||||
name: "ScoringRuleOptions"
|
||||
nameWithType: "ScoringRuleOptions"
|
||||
summary: "Encapsulates all options that can be passed as parameters for scoring rule with Best<wbr>Worker<wbr>Mode."
|
||||
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 **ScoringRuleOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.ScoringRuleOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.ScoringRuleOptions()"
|
||||
name: "ScoringRuleOptions()"
|
||||
nameWithType: "ScoringRuleOptions.ScoringRuleOptions()"
|
||||
summary: "Creates an instance of Scoring<wbr>Rule<wbr>Options class."
|
||||
syntax: "public ScoringRuleOptions()"
|
||||
desc: "Creates an instance of ScoringRuleOptions class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.getBatchSize()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.getBatchSize()"
|
||||
name: "getBatchSize()"
|
||||
nameWithType: "ScoringRuleOptions.getBatchSize()"
|
||||
summary: "Get the batch<wbr>Size property: Set batch size when 'is<wbr>Batch<wbr>Scoring<wbr>Enabled' is set to true."
|
||||
syntax: "public Integer getBatchSize()"
|
||||
desc: "Get the batchSize property: Set batch size when 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured."
|
||||
returns:
|
||||
description: "the batchSize value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.getScoringParameters()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.getScoringParameters()"
|
||||
name: "getScoringParameters()"
|
||||
nameWithType: "ScoringRuleOptions.getScoringParameters()"
|
||||
summary: "Get the scoring<wbr>Parameters property: List of extra parameters from a job that will be sent as part of the payload to scoring rule."
|
||||
syntax: "public List<ScoringRuleParameterSelector> getScoringParameters()"
|
||||
desc: "Get the scoringParameters property: List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as \\`job\\`) and a job's worker selectors (sent in the payload as \\`selectors\\`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload."
|
||||
returns:
|
||||
description: "the scoringParameters value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.isBatchScoringEnabled()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.isBatchScoringEnabled()"
|
||||
name: "isBatchScoringEnabled()"
|
||||
nameWithType: "ScoringRuleOptions.isBatchScoringEnabled()"
|
||||
summary: "Get the is<wbr>Batch<wbr>Scoring<wbr>Enabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`."
|
||||
syntax: "public Boolean isBatchScoringEnabled()"
|
||||
desc: "Get the isBatchScoringEnabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`. By default, set to false and the parameter name for the worker labels will be sent as \\`worker\\`. Note: If enabled, use 'batchSize' to set batch size."
|
||||
returns:
|
||||
description: "the isBatchScoringEnabled value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.isDescendingOrder()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.isDescendingOrder()"
|
||||
name: "isDescendingOrder()"
|
||||
nameWithType: "ScoringRuleOptions.isDescendingOrder()"
|
||||
summary: "Get the descending<wbr>Order property: If false, will sort scores by ascending order."
|
||||
syntax: "public Boolean isDescendingOrder()"
|
||||
desc: "Get the descendingOrder property: If false, will sort scores by ascending order. By default, set to true."
|
||||
returns:
|
||||
description: "the descendingOrder value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setBatchScoringEnabled(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
name: "setBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
nameWithType: "ScoringRuleOptions.setBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
summary: "Set the is<wbr>Batch<wbr>Scoring<wbr>Enabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`."
|
||||
parameters:
|
||||
- description: "the isBatchScoringEnabled value to set."
|
||||
name: "isBatchScoringEnabled"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public ScoringRuleOptions setBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
desc: "Set the isBatchScoringEnabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`. By default, set to false and the parameter name for the worker labels will be sent as \\`worker\\`. Note: If enabled, use 'batchSize' to set batch size."
|
||||
returns:
|
||||
description: "the ScoringRuleOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setBatchSize(java.lang.Integer)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setBatchSize(Integer batchSize)"
|
||||
name: "setBatchSize(Integer batchSize)"
|
||||
nameWithType: "ScoringRuleOptions.setBatchSize(Integer batchSize)"
|
||||
summary: "Set the batch<wbr>Size property: Set batch size when 'is<wbr>Batch<wbr>Scoring<wbr>Enabled' is set to true."
|
||||
parameters:
|
||||
- description: "the batchSize value to set."
|
||||
name: "batchSize"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
||||
syntax: "public ScoringRuleOptions setBatchSize(Integer batchSize)"
|
||||
desc: "Set the batchSize property: Set batch size when 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured."
|
||||
returns:
|
||||
description: "the ScoringRuleOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setDescendingOrder(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setDescendingOrder(Boolean descendingOrder)"
|
||||
name: "setDescendingOrder(Boolean descendingOrder)"
|
||||
nameWithType: "ScoringRuleOptions.setDescendingOrder(Boolean descendingOrder)"
|
||||
summary: "Set the descending<wbr>Order property: If false, will sort scores by ascending order."
|
||||
parameters:
|
||||
- description: "the descendingOrder value to set."
|
||||
name: "descendingOrder"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public ScoringRuleOptions setDescendingOrder(Boolean descendingOrder)"
|
||||
desc: "Set the descendingOrder property: If false, will sort scores by ascending order. By default, set to true."
|
||||
returns:
|
||||
description: "the ScoringRuleOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setIsBatchScoringEnabled(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setIsBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
name: "setIsBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
nameWithType: "ScoringRuleOptions.setIsBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
summary: "Set the is<wbr>Batch<wbr>Scoring<wbr>Enabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`."
|
||||
parameters:
|
||||
- description: "the isBatchScoringEnabled value to set."
|
||||
name: "isBatchScoringEnabled"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public ScoringRuleOptions setIsBatchScoringEnabled(Boolean isBatchScoringEnabled)"
|
||||
desc: "Set the isBatchScoringEnabled property: If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as \\`workers\\`. By default, set to false and the parameter name for the worker labels will be sent as \\`worker\\`. Note: If enabled, use 'batchSize' to set batch size."
|
||||
returns:
|
||||
description: "the ScoringRuleOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setScoringParameters(java.util.List<com.azure.communication.jobrouter.models.ScoringRuleParameterSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleOptions.setScoringParameters(List<ScoringRuleParameterSelector> scoringParameters)"
|
||||
name: "setScoringParameters(List<ScoringRuleParameterSelector> scoringParameters)"
|
||||
nameWithType: "ScoringRuleOptions.setScoringParameters(List<ScoringRuleParameterSelector> scoringParameters)"
|
||||
summary: "Set the scoring<wbr>Parameters property: List of extra parameters from a job that will be sent as part of the payload to scoring rule."
|
||||
parameters:
|
||||
- description: "the scoringParameters value to set."
|
||||
name: "scoringParameters"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public ScoringRuleOptions setScoringParameters(List<ScoringRuleParameterSelector> scoringParameters)"
|
||||
desc: "Set the scoringParameters property: List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as \\`job\\`) and a job's worker selectors (sent in the payload as \\`selectors\\`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload."
|
||||
returns:
|
||||
description: "the ScoringRuleOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleOptions?alt=com.azure.communication.jobrouter.models.ScoringRuleOptions&text=ScoringRuleOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,97 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector"
|
||||
name: "ScoringRuleParameterSelector"
|
||||
nameWithType: "ScoringRuleParameterSelector"
|
||||
summary: "Supported parameters for scoring workers used with Best<wbr>Worker<wbr>Mode."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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#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#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#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 **ScoringRuleParameterSelector**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.ScoringRuleParameterSelector()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.ScoringRuleParameterSelector()"
|
||||
name: "ScoringRuleParameterSelector()"
|
||||
nameWithType: "ScoringRuleParameterSelector.ScoringRuleParameterSelector()"
|
||||
summary: "Creates a new instance of Scoring<wbr>Rule<wbr>Parameter<wbr>Selector value."
|
||||
deprecatedTag: "Use the <xref uid=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
|
||||
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ScoringRuleParameterSelector()"
|
||||
desc: "Creates a new instance of ScoringRuleParameterSelector value."
|
||||
hasDeprecatedTag: true
|
||||
fields:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.JOB_LABELS"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.JOB_LABELS"
|
||||
name: "JOB_LABELS"
|
||||
nameWithType: "ScoringRuleParameterSelector.JOB_LABELS"
|
||||
summary: "Parameter to add job labels to scoring payload."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ScoringRuleParameterSelector JOB_LABELS"
|
||||
desc: "Parameter to add job labels to scoring payload. Property is sent as \\`job\\`."
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.WORKER_SELECTORS"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.WORKER_SELECTORS"
|
||||
name: "WORKER_SELECTORS"
|
||||
nameWithType: "ScoringRuleParameterSelector.WORKER_SELECTORS"
|
||||
summary: "Parameter to add worker selectors from a job to scoring payload."
|
||||
modifiers:
|
||||
- "static"
|
||||
- "final"
|
||||
field:
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public static final ScoringRuleParameterSelector WORKER_SELECTORS"
|
||||
desc: "Parameter to add worker selectors from a job to scoring payload. Property is sent as \\`selectors\\`."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.fromString(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.fromString(String name)"
|
||||
name: "fromString(String name)"
|
||||
nameWithType: "ScoringRuleParameterSelector.fromString(String name)"
|
||||
summary: "Creates or finds a Scoring<wbr>Rule<wbr>Parameter<wbr>Selector from its string representation."
|
||||
modifiers:
|
||||
- "static"
|
||||
parameters:
|
||||
- description: "a name to look for."
|
||||
name: "name"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public static ScoringRuleParameterSelector fromString(String name)"
|
||||
desc: "Creates or finds a ScoringRuleParameterSelector from its string representation."
|
||||
returns:
|
||||
description: "the corresponding ScoringRuleParameterSelector."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.values()"
|
||||
fullName: "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector.values()"
|
||||
name: "values()"
|
||||
nameWithType: "ScoringRuleParameterSelector.values()"
|
||||
summary: "Gets known Scoring<wbr>Rule<wbr>Parameter<wbr>Selector values."
|
||||
modifiers:
|
||||
- "static"
|
||||
syntax: "public static Collection<ScoringRuleParameterSelector> values()"
|
||||
desc: "Gets known ScoringRuleParameterSelector values."
|
||||
returns:
|
||||
description: "known ScoringRuleParameterSelector values."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a><<xref href=\"com.azure.communication.jobrouter.models.ScoringRuleParameterSelector?alt=com.azure.communication.jobrouter.models.ScoringRuleParameterSelector&text=ScoringRuleParameterSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Supported parameters for scoring workers used with BestWorkerMode."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment"
|
||||
name: "StaticQueueSelectorAttachment"
|
||||
nameWithType: "StaticQueueSelectorAttachment"
|
||||
summary: "Describes a queue selector that will be attached to the job."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **StaticQueueSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment.StaticQueueSelectorAttachment(com.azure.communication.jobrouter.models.RouterQueueSelector)"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment.StaticQueueSelectorAttachment(RouterQueueSelector queueSelector)"
|
||||
name: "StaticQueueSelectorAttachment(RouterQueueSelector queueSelector)"
|
||||
nameWithType: "StaticQueueSelectorAttachment.StaticQueueSelectorAttachment(RouterQueueSelector queueSelector)"
|
||||
summary: "Creates an instance of Static<wbr>Queue<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the queueSelector value to set."
|
||||
name: "queueSelector"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public StaticQueueSelectorAttachment(RouterQueueSelector queueSelector)"
|
||||
desc: "Creates an instance of StaticQueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment.getQueueSelector()"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment.getQueueSelector()"
|
||||
name: "getQueueSelector()"
|
||||
nameWithType: "StaticQueueSelectorAttachment.getQueueSelector()"
|
||||
summary: "Get the queue<wbr>Selector property: Describes a condition that must be met against a set of labels for queue selection."
|
||||
syntax: "public RouterQueueSelector getQueueSelector()"
|
||||
desc: "Get the queueSelector property: Describes a condition that must be met against a set of labels for queue selection."
|
||||
returns:
|
||||
description: "the queueSelector value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterQueueSelector?alt=com.azure.communication.jobrouter.models.RouterQueueSelector&text=RouterQueueSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Describes a queue selector that will be attached to the job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.StaticRouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticRouterRule"
|
||||
name: "StaticRouterRule"
|
||||
nameWithType: "StaticRouterRule"
|
||||
summary: "A rule providing static rules that always return the same result, regardless of input."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule.getKind()?alt=com.azure.communication.jobrouter.models.RouterRule.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **StaticRouterRule**</br> extends <xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticRouterRule.StaticRouterRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticRouterRule.StaticRouterRule()"
|
||||
name: "StaticRouterRule()"
|
||||
nameWithType: "StaticRouterRule.StaticRouterRule()"
|
||||
summary: "Creates an instance of Static<wbr>Router<wbr>Rule class."
|
||||
syntax: "public StaticRouterRule()"
|
||||
desc: "Creates an instance of StaticRouterRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticRouterRule.getValue()"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticRouterRule.getValue()"
|
||||
name: "getValue()"
|
||||
nameWithType: "StaticRouterRule.getValue()"
|
||||
summary: "Get the value property: The static value this rule always returns."
|
||||
syntax: "public RouterValue getValue()"
|
||||
desc: "Get the value property: The static value this rule always returns."
|
||||
returns:
|
||||
description: "the value value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticRouterRule.setValue(com.azure.communication.jobrouter.models.RouterValue)"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticRouterRule.setValue(RouterValue value)"
|
||||
name: "setValue(RouterValue value)"
|
||||
nameWithType: "StaticRouterRule.setValue(RouterValue value)"
|
||||
summary: "Set the value property: The static value this rule always returns."
|
||||
parameters:
|
||||
- description: "the value value to set."
|
||||
name: "value"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterValue?alt=com.azure.communication.jobrouter.models.RouterValue&text=RouterValue\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public StaticRouterRule setValue(RouterValue value)"
|
||||
desc: "Set the value property: The static value this rule always returns."
|
||||
returns:
|
||||
description: "the StaticRouterRule object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.StaticRouterRule?alt=com.azure.communication.jobrouter.models.StaticRouterRule&text=StaticRouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rule providing static rules that always return the same result, regardless of input."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment"
|
||||
name: "StaticWorkerSelectorAttachment"
|
||||
nameWithType: "StaticWorkerSelectorAttachment"
|
||||
summary: "Describes a worker selector that will be attached to the job."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **StaticWorkerSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment.StaticWorkerSelectorAttachment(com.azure.communication.jobrouter.models.RouterWorkerSelector)"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment.StaticWorkerSelectorAttachment(RouterWorkerSelector workerSelector)"
|
||||
name: "StaticWorkerSelectorAttachment(RouterWorkerSelector workerSelector)"
|
||||
nameWithType: "StaticWorkerSelectorAttachment.StaticWorkerSelectorAttachment(RouterWorkerSelector workerSelector)"
|
||||
summary: "Creates an instance of Static<wbr>Worker<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the workerSelector value to set."
|
||||
name: "workerSelector"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public StaticWorkerSelectorAttachment(RouterWorkerSelector workerSelector)"
|
||||
desc: "Creates an instance of StaticWorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment.getWorkerSelector()"
|
||||
fullName: "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment.getWorkerSelector()"
|
||||
name: "getWorkerSelector()"
|
||||
nameWithType: "StaticWorkerSelectorAttachment.getWorkerSelector()"
|
||||
summary: "Get the worker<wbr>Selector property: Describes a condition that must be met against a set of labels for worker selection."
|
||||
syntax: "public RouterWorkerSelector getWorkerSelector()"
|
||||
desc: "Get the workerSelector property: Describes a condition that must be met against a set of labels for worker selection."
|
||||
returns:
|
||||
description: "the workerSelector value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Describes a worker selector that will be attached to the job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.SuspendMode"
|
||||
fullName: "com.azure.communication.jobrouter.models.SuspendMode"
|
||||
name: "SuspendMode"
|
||||
nameWithType: "SuspendMode"
|
||||
summary: "Describes a matching mode where matching worker to a job is suspended."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode.getKind()?alt=com.azure.communication.jobrouter.models.JobMatchingMode.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **SuspendMode**</br> extends <xref href=\"com.azure.communication.jobrouter.models.JobMatchingMode?alt=com.azure.communication.jobrouter.models.JobMatchingMode&text=JobMatchingMode\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.SuspendMode.SuspendMode()"
|
||||
fullName: "com.azure.communication.jobrouter.models.SuspendMode.SuspendMode()"
|
||||
name: "SuspendMode()"
|
||||
nameWithType: "SuspendMode.SuspendMode()"
|
||||
summary: "Creates an instance of Suspend<wbr>Mode class."
|
||||
syntax: "public SuspendMode()"
|
||||
desc: "Creates an instance of SuspendMode class."
|
||||
type: "class"
|
||||
desc: "Describes a matching mode where matching worker to a job is suspended."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.UnassignJobOptions"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobOptions"
|
||||
name: "UnassignJobOptions"
|
||||
nameWithType: "UnassignJobOptions"
|
||||
summary: "Request payload for unassigning a job."
|
||||
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 **UnassignJobOptions**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.UnassignJobOptions.UnassignJobOptions()"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobOptions.UnassignJobOptions()"
|
||||
name: "UnassignJobOptions()"
|
||||
nameWithType: "UnassignJobOptions.UnassignJobOptions()"
|
||||
summary: "Creates an instance of Unassign<wbr>Job<wbr>Options class."
|
||||
syntax: "public UnassignJobOptions()"
|
||||
desc: "Creates an instance of UnassignJobOptions class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.UnassignJobOptions.isSuspendMatching()"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobOptions.isSuspendMatching()"
|
||||
name: "isSuspendMatching()"
|
||||
nameWithType: "UnassignJobOptions.isSuspendMatching()"
|
||||
summary: "Get the suspend<wbr>Matching property: If Suspend<wbr>Matching is true, then a job is not queued for re-matching with a worker."
|
||||
syntax: "public Boolean isSuspendMatching()"
|
||||
desc: "Get the suspendMatching property: If SuspendMatching is true, then a job is not queued for re-matching with a worker."
|
||||
returns:
|
||||
description: "the suspendMatching value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.UnassignJobOptions.setSuspendMatching(java.lang.Boolean)"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobOptions.setSuspendMatching(Boolean suspendMatching)"
|
||||
name: "setSuspendMatching(Boolean suspendMatching)"
|
||||
nameWithType: "UnassignJobOptions.setSuspendMatching(Boolean suspendMatching)"
|
||||
summary: "Set the suspend<wbr>Matching property: If Suspend<wbr>Matching is true, then a job is not queued for re-matching with a worker."
|
||||
parameters:
|
||||
- description: "the suspendMatching value to set."
|
||||
name: "suspendMatching"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
||||
syntax: "public UnassignJobOptions setSuspendMatching(Boolean suspendMatching)"
|
||||
desc: "Set the suspendMatching property: If SuspendMatching is true, then a job is not queued for re-matching with a worker."
|
||||
returns:
|
||||
description: "the UnassignJobOptions object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.UnassignJobOptions?alt=com.azure.communication.jobrouter.models.UnassignJobOptions&text=UnassignJobOptions\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Request payload for unassigning a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.UnassignJobResult"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobResult"
|
||||
name: "UnassignJobResult"
|
||||
nameWithType: "UnassignJobResult"
|
||||
summary: "Response payload after a job has been successfully unassigned."
|
||||
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 **UnassignJobResult**"
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.UnassignJobResult.getJobId()"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobResult.getJobId()"
|
||||
name: "getJobId()"
|
||||
nameWithType: "UnassignJobResult.getJobId()"
|
||||
summary: "Get the job<wbr>Id property: Id of an unassigned job."
|
||||
syntax: "public String getJobId()"
|
||||
desc: "Get the jobId property: Id of an unassigned job."
|
||||
returns:
|
||||
description: "the jobId value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.UnassignJobResult.getUnassignmentCount()"
|
||||
fullName: "com.azure.communication.jobrouter.models.UnassignJobResult.getUnassignmentCount()"
|
||||
name: "getUnassignmentCount()"
|
||||
nameWithType: "UnassignJobResult.getUnassignmentCount()"
|
||||
summary: "Get the unassignment<wbr>Count property: The number of times a job is unassigned."
|
||||
syntax: "public int getUnassignmentCount()"
|
||||
desc: "Get the unassignmentCount property: The number of times a job is unassigned. At a maximum 3."
|
||||
returns:
|
||||
description: "the unassignmentCount value."
|
||||
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "Response payload after a job has been successfully unassigned."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger"
|
||||
fullName: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger"
|
||||
name: "WaitTimeExceptionTrigger"
|
||||
nameWithType: "WaitTimeExceptionTrigger"
|
||||
summary: "Trigger for an exception action on exceeding wait time."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger.getKind()?alt=com.azure.communication.jobrouter.models.ExceptionTrigger.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **WaitTimeExceptionTrigger**</br> extends <xref href=\"com.azure.communication.jobrouter.models.ExceptionTrigger?alt=com.azure.communication.jobrouter.models.ExceptionTrigger&text=ExceptionTrigger\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger.WaitTimeExceptionTrigger(java.time.Duration)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger.WaitTimeExceptionTrigger(Duration threshold)"
|
||||
name: "WaitTimeExceptionTrigger(Duration threshold)"
|
||||
nameWithType: "WaitTimeExceptionTrigger.WaitTimeExceptionTrigger(Duration threshold)"
|
||||
summary: "Creates an instance of Wait<wbr>Time<wbr>Exception<wbr>Trigger class."
|
||||
parameters:
|
||||
- description: "the thresholdSeconds value to set."
|
||||
name: "threshold"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
syntax: "public WaitTimeExceptionTrigger(Duration threshold)"
|
||||
desc: "Creates an instance of WaitTimeExceptionTrigger class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger.getThreshold()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger.getThreshold()"
|
||||
name: "getThreshold()"
|
||||
nameWithType: "WaitTimeExceptionTrigger.getThreshold()"
|
||||
summary: "Get the threshold<wbr>Seconds property: Threshold for wait time for this trigger."
|
||||
syntax: "public Duration getThreshold()"
|
||||
desc: "Get the thresholdSeconds property: Threshold for wait time for this trigger."
|
||||
returns:
|
||||
description: "the thresholdSeconds value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
||||
type: "class"
|
||||
desc: "Trigger for an exception action on exceeding wait time."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WebhookRouterRule"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule"
|
||||
name: "WebhookRouterRule"
|
||||
nameWithType: "WebhookRouterRule"
|
||||
summary: "A rule providing a binding to an external web server."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.RouterRule.getKind()?alt=com.azure.communication.jobrouter.models.RouterRule.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **WebhookRouterRule**</br> extends <xref href=\"com.azure.communication.jobrouter.models.RouterRule?alt=com.azure.communication.jobrouter.models.RouterRule&text=RouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.WebhookRouterRule()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.WebhookRouterRule()"
|
||||
name: "WebhookRouterRule()"
|
||||
nameWithType: "WebhookRouterRule.WebhookRouterRule()"
|
||||
summary: "Creates an instance of Webhook<wbr>Router<wbr>Rule class."
|
||||
syntax: "public WebhookRouterRule()"
|
||||
desc: "Creates an instance of WebhookRouterRule class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.getAuthorizationServerUri()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.getAuthorizationServerUri()"
|
||||
name: "getAuthorizationServerUri()"
|
||||
nameWithType: "WebhookRouterRule.getAuthorizationServerUri()"
|
||||
summary: "Get the authorization<wbr>Server<wbr>Uri property: Uri for Authorization Server."
|
||||
syntax: "public String getAuthorizationServerUri()"
|
||||
desc: "Get the authorizationServerUri property: Uri for Authorization Server."
|
||||
returns:
|
||||
description: "the authorizationServerUri value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.getClientCredential()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.getClientCredential()"
|
||||
name: "getClientCredential()"
|
||||
nameWithType: "WebhookRouterRule.getClientCredential()"
|
||||
summary: "Get the client<wbr>Credential property: OAuth2.0 Credentials used to Contoso's Authorization server."
|
||||
syntax: "public OAuth2WebhookClientCredential getClientCredential()"
|
||||
desc: "Get the clientCredential property: OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/."
|
||||
returns:
|
||||
description: "the clientCredential value."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential?alt=com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential&text=OAuth2WebhookClientCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.getWebhookUri()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.getWebhookUri()"
|
||||
name: "getWebhookUri()"
|
||||
nameWithType: "WebhookRouterRule.getWebhookUri()"
|
||||
summary: "Get the webhook<wbr>Uri property: Uri for Contoso's Web Server."
|
||||
syntax: "public String getWebhookUri()"
|
||||
desc: "Get the webhookUri property: Uri for Contoso's Web Server."
|
||||
returns:
|
||||
description: "the webhookUri value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.setAuthorizationServerUri(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.setAuthorizationServerUri(String authorizationServerUri)"
|
||||
name: "setAuthorizationServerUri(String authorizationServerUri)"
|
||||
nameWithType: "WebhookRouterRule.setAuthorizationServerUri(String authorizationServerUri)"
|
||||
summary: "Set the authorization<wbr>Server<wbr>Uri property: Uri for Authorization Server."
|
||||
parameters:
|
||||
- description: "the authorizationServerUri value to set."
|
||||
name: "authorizationServerUri"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public WebhookRouterRule setAuthorizationServerUri(String authorizationServerUri)"
|
||||
desc: "Set the authorizationServerUri property: Uri for Authorization Server."
|
||||
returns:
|
||||
description: "the WebhookRouterRule object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.WebhookRouterRule?alt=com.azure.communication.jobrouter.models.WebhookRouterRule&text=WebhookRouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.setClientCredential(com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.setClientCredential(OAuth2WebhookClientCredential clientCredential)"
|
||||
name: "setClientCredential(OAuth2WebhookClientCredential clientCredential)"
|
||||
nameWithType: "WebhookRouterRule.setClientCredential(OAuth2WebhookClientCredential clientCredential)"
|
||||
summary: "Set the client<wbr>Credential property: OAuth2.0 Credentials used to Contoso's Authorization server."
|
||||
parameters:
|
||||
- description: "the clientCredential value to set."
|
||||
name: "clientCredential"
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential?alt=com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential&text=OAuth2WebhookClientCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
syntax: "public WebhookRouterRule setClientCredential(OAuth2WebhookClientCredential clientCredential)"
|
||||
desc: "Set the clientCredential property: OAuth2.0 Credentials used to Contoso's Authorization server. Reference: https://www.oauth.com/oauth2-servers/access-tokens/client-credentials/."
|
||||
returns:
|
||||
description: "the WebhookRouterRule object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.WebhookRouterRule?alt=com.azure.communication.jobrouter.models.WebhookRouterRule&text=WebhookRouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.WebhookRouterRule.setWebhookUri(java.lang.String)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WebhookRouterRule.setWebhookUri(String webhookUri)"
|
||||
name: "setWebhookUri(String webhookUri)"
|
||||
nameWithType: "WebhookRouterRule.setWebhookUri(String webhookUri)"
|
||||
summary: "Set the webhook<wbr>Uri property: Uri for Contoso's Web Server."
|
||||
parameters:
|
||||
- description: "the webhookUri value to set."
|
||||
name: "webhookUri"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
syntax: "public WebhookRouterRule setWebhookUri(String webhookUri)"
|
||||
desc: "Set the webhookUri property: Uri for Contoso's Web Server."
|
||||
returns:
|
||||
description: "the WebhookRouterRule object itself."
|
||||
type: "<xref href=\"com.azure.communication.jobrouter.models.WebhookRouterRule?alt=com.azure.communication.jobrouter.models.WebhookRouterRule&text=WebhookRouterRule\" data-throw-if-not-resolved=\"False\" />"
|
||||
type: "class"
|
||||
desc: "A rule providing a binding to an external web server."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment"
|
||||
name: "WeightedAllocationQueueSelectorAttachment"
|
||||
nameWithType: "WeightedAllocationQueueSelectorAttachment"
|
||||
summary: "Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **WeightedAllocationQueueSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.QueueSelectorAttachment?alt=com.azure.communication.jobrouter.models.QueueSelectorAttachment&text=QueueSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment.WeightedAllocationQueueSelectorAttachment(java.util.List<com.azure.communication.jobrouter.models.QueueWeightedAllocation>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment.WeightedAllocationQueueSelectorAttachment(List<QueueWeightedAllocation> allocations)"
|
||||
name: "WeightedAllocationQueueSelectorAttachment(List<QueueWeightedAllocation> allocations)"
|
||||
nameWithType: "WeightedAllocationQueueSelectorAttachment.WeightedAllocationQueueSelectorAttachment(List<QueueWeightedAllocation> allocations)"
|
||||
summary: "Creates an instance of Weighted<wbr>Allocation<wbr>Queue<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the allocations value to set."
|
||||
name: "allocations"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueWeightedAllocation?alt=com.azure.communication.jobrouter.models.QueueWeightedAllocation&text=QueueWeightedAllocation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public WeightedAllocationQueueSelectorAttachment(List<QueueWeightedAllocation> allocations)"
|
||||
desc: "Creates an instance of WeightedAllocationQueueSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment.getAllocations()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment.getAllocations()"
|
||||
name: "getAllocations()"
|
||||
nameWithType: "WeightedAllocationQueueSelectorAttachment.getAllocations()"
|
||||
summary: "Get the allocations property: A collection of percentage based weighted allocations."
|
||||
syntax: "public List<QueueWeightedAllocation> getAllocations()"
|
||||
desc: "Get the allocations property: A collection of percentage based weighted allocations."
|
||||
returns:
|
||||
description: "the allocations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.QueueWeightedAllocation?alt=com.azure.communication.jobrouter.models.QueueWeightedAllocation&text=QueueWeightedAllocation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment"
|
||||
name: "WeightedAllocationWorkerSelectorAttachment"
|
||||
nameWithType: "WeightedAllocationWorkerSelectorAttachment"
|
||||
summary: "Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting."
|
||||
inheritances:
|
||||
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
||||
inheritedClassMethods:
|
||||
- classRef: "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
methodsRef:
|
||||
- "<xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
||||
- 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 **WeightedAllocationWorkerSelectorAttachment**</br> extends <xref href=\"com.azure.communication.jobrouter.models.WorkerSelectorAttachment?alt=com.azure.communication.jobrouter.models.WorkerSelectorAttachment&text=WorkerSelectorAttachment\" data-throw-if-not-resolved=\"False\" />"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment.WeightedAllocationWorkerSelectorAttachment(java.util.List<com.azure.communication.jobrouter.models.WorkerWeightedAllocation>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment.WeightedAllocationWorkerSelectorAttachment(List<WorkerWeightedAllocation> allocations)"
|
||||
name: "WeightedAllocationWorkerSelectorAttachment(List<WorkerWeightedAllocation> allocations)"
|
||||
nameWithType: "WeightedAllocationWorkerSelectorAttachment.WeightedAllocationWorkerSelectorAttachment(List<WorkerWeightedAllocation> allocations)"
|
||||
summary: "Creates an instance of Weighted<wbr>Allocation<wbr>Worker<wbr>Selector<wbr>Attachment class."
|
||||
parameters:
|
||||
- description: "the allocations value to set."
|
||||
name: "allocations"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerWeightedAllocation?alt=com.azure.communication.jobrouter.models.WorkerWeightedAllocation&text=WorkerWeightedAllocation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public WeightedAllocationWorkerSelectorAttachment(List<WorkerWeightedAllocation> allocations)"
|
||||
desc: "Creates an instance of WeightedAllocationWorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment.getAllocations()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment.getAllocations()"
|
||||
name: "getAllocations()"
|
||||
nameWithType: "WeightedAllocationWorkerSelectorAttachment.getAllocations()"
|
||||
summary: "Get the allocations property: A collection of percentage based weighted allocations."
|
||||
syntax: "public List<WorkerWeightedAllocation> getAllocations()"
|
||||
desc: "Get the allocations property: A collection of percentage based weighted allocations."
|
||||
returns:
|
||||
description: "the allocations value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.WorkerWeightedAllocation?alt=com.azure.communication.jobrouter.models.WorkerWeightedAllocation&text=WorkerWeightedAllocation\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment"
|
||||
name: "WorkerSelectorAttachment"
|
||||
nameWithType: "WorkerSelectorAttachment"
|
||||
summary: "An attachment which attaches worker selectors to a job."
|
||||
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 abstract class **WorkerSelectorAttachment**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment.WorkerSelectorAttachment()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment.WorkerSelectorAttachment()"
|
||||
name: "WorkerSelectorAttachment()"
|
||||
nameWithType: "WorkerSelectorAttachment.WorkerSelectorAttachment()"
|
||||
summary: "Creates an instance of Worker<wbr>Selector<wbr>Attachment class."
|
||||
syntax: "public WorkerSelectorAttachment()"
|
||||
desc: "Creates an instance of WorkerSelectorAttachment class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerSelectorAttachment.getKind()"
|
||||
name: "getKind()"
|
||||
nameWithType: "WorkerSelectorAttachment.getKind()"
|
||||
summary: "Returns kind discriminator."
|
||||
syntax: "public String getKind()"
|
||||
desc: "Returns kind discriminator."
|
||||
returns:
|
||||
description: "kind."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
||||
type: "class"
|
||||
desc: "An attachment which attaches worker selectors to a job."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
### YamlMime:JavaType
|
||||
uid: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation"
|
||||
name: "WorkerWeightedAllocation"
|
||||
nameWithType: "WorkerWeightedAllocation"
|
||||
summary: "Contains the weight percentage and worker selectors to be applied if selected for weighted distributions."
|
||||
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 **WorkerWeightedAllocation**"
|
||||
constructors:
|
||||
- uid: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.WorkerWeightedAllocation(double,java.util.List<com.azure.communication.jobrouter.models.RouterWorkerSelector>)"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.WorkerWeightedAllocation(double weight, List<RouterWorkerSelector> workerSelectors)"
|
||||
name: "WorkerWeightedAllocation(double weight, List<RouterWorkerSelector> workerSelectors)"
|
||||
nameWithType: "WorkerWeightedAllocation.WorkerWeightedAllocation(double weight, List<RouterWorkerSelector> workerSelectors)"
|
||||
summary: "Creates an instance of Worker<wbr>Weighted<wbr>Allocation class."
|
||||
parameters:
|
||||
- description: "the weight value to set."
|
||||
name: "weight"
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- description: "the workerSelectors value to set."
|
||||
name: "workerSelectors"
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
syntax: "public WorkerWeightedAllocation(double weight, List<RouterWorkerSelector> workerSelectors)"
|
||||
desc: "Creates an instance of WorkerWeightedAllocation class."
|
||||
methods:
|
||||
- uid: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.getWeight()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.getWeight()"
|
||||
name: "getWeight()"
|
||||
nameWithType: "WorkerWeightedAllocation.getWeight()"
|
||||
summary: "Get the weight property: The percentage of this weight, expressed as a fraction of 1."
|
||||
syntax: "public double getWeight()"
|
||||
desc: "Get the weight property: The percentage of this weight, expressed as a fraction of 1."
|
||||
returns:
|
||||
description: "the weight value."
|
||||
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
||||
- uid: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.getWorkerSelectors()"
|
||||
fullName: "com.azure.communication.jobrouter.models.WorkerWeightedAllocation.getWorkerSelectors()"
|
||||
name: "getWorkerSelectors()"
|
||||
nameWithType: "WorkerWeightedAllocation.getWorkerSelectors()"
|
||||
summary: "Get the worker<wbr>Selectors property: A collection of worker selectors that will be applied if this allocation is selected."
|
||||
syntax: "public List<RouterWorkerSelector> getWorkerSelectors()"
|
||||
desc: "Get the workerSelectors property: A collection of worker selectors that will be applied if this allocation is selected."
|
||||
returns:
|
||||
description: "the workerSelectors value."
|
||||
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.jobrouter.models.RouterWorkerSelector?alt=com.azure.communication.jobrouter.models.RouterWorkerSelector&text=RouterWorkerSelector\" data-throw-if-not-resolved=\"False\" />>"
|
||||
type: "class"
|
||||
desc: "Contains the weight percentage and worker selectors to be applied if selected for weighted distributions."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.communication.jobrouter.models"
|
||||
fullName: "com.azure.communication.jobrouter.models"
|
||||
name: "com.azure.communication.jobrouter.models"
|
||||
summary: "Package containing the data models for AzureCommunicationRoutingService."
|
||||
classes:
|
||||
- "com.azure.communication.jobrouter.models.AcceptJobOfferResult"
|
||||
- "com.azure.communication.jobrouter.models.BestWorkerMode"
|
||||
- "com.azure.communication.jobrouter.models.CancelExceptionAction"
|
||||
- "com.azure.communication.jobrouter.models.CancelJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.ClassificationPolicy"
|
||||
- "com.azure.communication.jobrouter.models.CloseJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.CompleteJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.ConditionalQueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.ConditionalWorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.CreateClassificationPolicyOptions"
|
||||
- "com.azure.communication.jobrouter.models.CreateDistributionPolicyOptions"
|
||||
- "com.azure.communication.jobrouter.models.CreateExceptionPolicyOptions"
|
||||
- "com.azure.communication.jobrouter.models.CreateJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.CreateQueueOptions"
|
||||
- "com.azure.communication.jobrouter.models.CreateWorkerOptions"
|
||||
- "com.azure.communication.jobrouter.models.DeclineJobOfferOptions"
|
||||
- "com.azure.communication.jobrouter.models.DirectMapRouterRule"
|
||||
- "com.azure.communication.jobrouter.models.DistributionMode"
|
||||
- "com.azure.communication.jobrouter.models.DistributionPolicy"
|
||||
- "com.azure.communication.jobrouter.models.ExceptionAction"
|
||||
- "com.azure.communication.jobrouter.models.ExceptionPolicy"
|
||||
- "com.azure.communication.jobrouter.models.ExceptionRule"
|
||||
- "com.azure.communication.jobrouter.models.ExceptionTrigger"
|
||||
- "com.azure.communication.jobrouter.models.ExpressionRouterRule"
|
||||
- "com.azure.communication.jobrouter.models.ExpressionRouterRuleLanguage"
|
||||
- "com.azure.communication.jobrouter.models.FunctionRouterRule"
|
||||
- "com.azure.communication.jobrouter.models.FunctionRouterRuleCredential"
|
||||
- "com.azure.communication.jobrouter.models.JobMatchingMode"
|
||||
- "com.azure.communication.jobrouter.models.LabelOperator"
|
||||
- "com.azure.communication.jobrouter.models.LongestIdleMode"
|
||||
- "com.azure.communication.jobrouter.models.ManualReclassifyExceptionAction"
|
||||
- "com.azure.communication.jobrouter.models.OAuth2WebhookClientCredential"
|
||||
- "com.azure.communication.jobrouter.models.PassThroughQueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.PassThroughWorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.QueueAndMatchMode"
|
||||
- "com.azure.communication.jobrouter.models.QueueLengthExceptionTrigger"
|
||||
- "com.azure.communication.jobrouter.models.QueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.QueueWeightedAllocation"
|
||||
- "com.azure.communication.jobrouter.models.ReclassifyExceptionAction"
|
||||
- "com.azure.communication.jobrouter.models.ReclassifyJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.ReclassifyJobOptionsInternal"
|
||||
- "com.azure.communication.jobrouter.models.RoundRobinMode"
|
||||
- "com.azure.communication.jobrouter.models.RouterChannel"
|
||||
- "com.azure.communication.jobrouter.models.RouterJob"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobAssignment"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobNote"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobOffer"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobPositionDetails"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobStatus"
|
||||
- "com.azure.communication.jobrouter.models.RouterJobStatusSelector"
|
||||
- "com.azure.communication.jobrouter.models.RouterQueue"
|
||||
- "com.azure.communication.jobrouter.models.RouterQueueSelector"
|
||||
- "com.azure.communication.jobrouter.models.RouterQueueStatistics"
|
||||
- "com.azure.communication.jobrouter.models.RouterRule"
|
||||
- "com.azure.communication.jobrouter.models.RouterValue"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorker"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorkerAssignment"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorkerSelector"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorkerSelectorStatus"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorkerState"
|
||||
- "com.azure.communication.jobrouter.models.RouterWorkerStateSelector"
|
||||
- "com.azure.communication.jobrouter.models.RuleEngineQueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.RuleEngineWorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.ScheduleAndSuspendMode"
|
||||
- "com.azure.communication.jobrouter.models.ScoringRuleOptions"
|
||||
- "com.azure.communication.jobrouter.models.ScoringRuleParameterSelector"
|
||||
- "com.azure.communication.jobrouter.models.StaticQueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.StaticRouterRule"
|
||||
- "com.azure.communication.jobrouter.models.StaticWorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.SuspendMode"
|
||||
- "com.azure.communication.jobrouter.models.UnassignJobOptions"
|
||||
- "com.azure.communication.jobrouter.models.UnassignJobResult"
|
||||
- "com.azure.communication.jobrouter.models.WaitTimeExceptionTrigger"
|
||||
- "com.azure.communication.jobrouter.models.WebhookRouterRule"
|
||||
- "com.azure.communication.jobrouter.models.WeightedAllocationQueueSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.WeightedAllocationWorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.WorkerSelectorAttachment"
|
||||
- "com.azure.communication.jobrouter.models.WorkerWeightedAllocation"
|
||||
desc: "Package containing the data models for AzureCommunicationRoutingService. Azure Communication Routing Service."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter.models"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
### YamlMime:JavaPackage
|
||||
uid: "com.azure.communication.jobrouter"
|
||||
fullName: "com.azure.communication.jobrouter"
|
||||
name: "com.azure.communication.jobrouter"
|
||||
summary: "Package containing the classes for AzureCommunicationRoutingService."
|
||||
classes:
|
||||
- "com.azure.communication.jobrouter.JobRouterAdministrationAsyncClient"
|
||||
- "com.azure.communication.jobrouter.JobRouterAdministrationClient"
|
||||
- "com.azure.communication.jobrouter.JobRouterAdministrationClientBuilder"
|
||||
- "com.azure.communication.jobrouter.JobRouterAsyncClient"
|
||||
- "com.azure.communication.jobrouter.JobRouterClient"
|
||||
- "com.azure.communication.jobrouter.JobRouterClientBuilder"
|
||||
enums:
|
||||
- "com.azure.communication.jobrouter.JobRouterServiceVersion"
|
||||
desc: "Package containing the classes for AzureCommunicationRoutingService. Azure Communication Routing Service."
|
||||
metadata: {}
|
||||
package: "com.azure.communication.jobrouter"
|
||||
artifact: com.azure:azure-communication-jobrouter:1.0.0
|
||||
|
|
@ -155,4 +155,4 @@ typeParameters:
|
|||
desc: "The base class for credential builders that allow specifying a client ID, tenant ID, authority host, and additionally allowed tenants for Microsoft Entra ID."
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -133,4 +133,4 @@ type: "class"
|
|||
desc: "Authentication Record represents the account information of the authenticated account. This is helpful in scenarios where applications require brokered authentication via <xref uid=\"com.azure.identity.DeviceCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredential\"></xref> or <xref uid=\"com.azure.identity.InteractiveBrowserCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InteractiveBrowserCredential\"></xref>.\n\nAuthentication record is returned when <xref uid=\"com.azure.identity.DeviceCodeCredential.authenticate()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredential#authenticate()\"></xref> or <xref uid=\"com.azure.identity.InteractiveBrowserCredential.authenticate()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InteractiveBrowserCredential#authenticate()\"></xref> api is invoked. The returned auth record can be stored/persisted in the user application. Further, this record can be configured on the <xref uid=\"com.azure.identity.DeviceCodeCredentialBuilder.authenticationRecord(com.azure.identity.AuthenticationRecord)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredentialBuilder#authenticationRecord(AuthenticationRecord)\"></xref> or <xref uid=\"com.azure.identity.InteractiveBrowserCredentialBuilder.authenticationRecord(com.azure.identity.AuthenticationRecord)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InteractiveBrowserCredentialBuilder#authenticationRecord(AuthenticationRecord)\"></xref> to proactively indicate that a previously authenticated account should be used from the persisted cache instead of authenticating again."
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -93,4 +93,4 @@ type: "class"
|
|||
desc: "The Authentication Required Exception is thrown by <xref uid=\"com.azure.identity.InteractiveBrowserCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InteractiveBrowserCredential\"></xref> and <xref uid=\"com.azure.identity.DeviceCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredential\"></xref> to indicate to the user that automatic authentication is disabled and authentication needs to be initiated via <xref uid=\"com.azure.identity.InteractiveBrowserCredential.authenticate()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InteractiveBrowserCredential#authenticate()\"></xref> or <xref uid=\"com.azure.identity.DeviceCodeCredential.authenticate()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"DeviceCodeCredential#authenticate()\"></xref> APIs respectively before fetching an access token."
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -38,4 +38,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -111,4 +111,4 @@ type: "class"
|
|||
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AuthorizationCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthorizationCodeCredential\"></xref>.\n\nAuthorization Code authentication in Azure is a type of authentication mechanism that allows users to authenticate with [Microsoft Entra ID][] and obtain an authorization code that can be used to request an access token to access Azure resources. It is a widely used authentication mechanism and is supported by a wide range of Azure services and applications. It provides a secure and scalable way to authenticate users and grant them access to Azure resources. The AuthorizationCodeCredential authenticates a user or an application and acquires a token with the configured authorization code and the redirectURL where authorization code was received.\n\n**Sample: Construct AuthorizationCodeCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.AuthorizationCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AuthorizationCodeCredential\"></xref>, using the <xref uid=\"com.azure.identity.AuthorizationCodeCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AuthorizationCodeCredentialBuilder\"></xref> to configure it. The `authorizationCode`, `redirectUrl` and `clientId` are required to be configured to create <xref uid=\"com.azure.identity.AuthorizationCodeCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AuthorizationCodeCredential\"></xref>. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential authorizationCodeCredential = new AuthorizationCodeCredentialBuilder()\n .authorizationCode(\"{authorization-code-received-at-redirectURL}\")\n .redirectUrl(\"{redirectUrl-where-authorization-code-is-received}\")\n .clientId(\"{clientId-of-application-being-authenticated\")\n .build();\n```\n\n\n[Microsoft Entra ID]: https://learn.microsoft.com/azure/active-directory/fundamentals/"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -78,4 +78,4 @@ type: "class"
|
|||
desc: "Defines fields exposing the well known authority hosts for the Azure Public Cloud and sovereign clouds.\n\nUsers looking to target a specific cloud instance of Azure, can pass an instance of Azure Authority Hosts as a parameter to the <xref uid=\"com.azure.identity.AadCredentialBuilderBase.authorityHost(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AadCredentialBuilderBase#authorityHost(String)\"></xref>. The authentication requests will be routed accordingly to the specified target authority host."
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -48,4 +48,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -114,4 +114,4 @@ type: "class"
|
|||
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureCliCredential\"></xref>.\n\nThe Azure CLI is a command-line tool that allows users to manage Azure resources from their local machine or terminal. It allows users to [authenticate interactively][] as a user and/or a service principal against [Microsoft Entra ID][]. The AzureCliCredential authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure CLI. It acts as the Azure CLI logged in user or service principal and executes an Azure CLI command underneath to authenticate the application against Microsoft Entra ID.\n\n**Sample: Construct IntelliJCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.AzureCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureCliCredential\"></xref>, using the <xref uid=\"com.azure.identity.AzureCliCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureCliCredentialBuilder\"></xref> to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential azureCliCredential = new AzureCliCredentialBuilder()\n .build();\n```\n\n\n[authenticate interactively]: https://learn.microsoft.com/cli/azure/authenticate-azure-cli\n[Microsoft Entra ID]: https://learn.microsoft.com/azure/active-directory/fundamentals/"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -48,4 +48,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -114,4 +114,4 @@ type: "class"
|
|||
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AzureDeveloperCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureDeveloperCliCredential\"></xref>.\n\nAzure Developer CLI is a command-line interface tool that allows developers to create, manage, and deploy resources in Azure. It's built on top of the Azure CLI and provides additional functionality specific to Azure developers. It allows users to authenticate as a user and/or a service principal against [Microsoft Entra ID][]. The AzureDeveloperCliCredential authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure Developer CLI. It acts as the Azure Developer CLI logged in user or service principal and executes an Azure CLI command underneath to authenticate the application against Microsoft Entra ID.\n\n**Sample: Construct AzureDeveloperCliCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.AzureDeveloperCliCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureDeveloperCliCredential\"></xref>, using the <xref uid=\"com.azure.identity.AzureDeveloperCliCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzureDeveloperCliCredentialBuilder\"></xref> to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential azureDevCliCredential = new AzureDeveloperCliCredentialBuilder()\n .build();\n```\n\n\n[Microsoft Entra ID]: https://learn.microsoft.com/azure/active-directory/fundamentals/"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -38,4 +38,4 @@ implements:
|
|||
- "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -100,4 +100,4 @@ type: "class"
|
|||
desc: "Fluent credential builder for instantiating a <xref uid=\"com.azure.identity.AzurePowerShellCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzurePowerShellCredential\"></xref>.\n\nThe Azure Powershell is a command-line tool that allows users to manage Azure resources from their local machine or terminal. It allows users to [authenticate interactively][] as a user and/or a service principal against [Microsoft Entra ID][]. The <xref uid=\"com.azure.identity.AzurePowerShellCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzurePowerShellCredential\"></xref> authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure Powershell. It acts as the Azure Powershell logged in user or service principal and executes an Azure Powershell command underneath to authenticate the application against Microsoft Entra ID.\n\n**Sample: Construct AzurePowershellCredential**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.identity.AzurePowerShellCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzurePowerShellCredential\"></xref>, using the <xref uid=\"com.azure.identity.AzurePowerShellCredentialBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.identity.AzurePowerShellCredentialBuilder\"></xref> to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.\n\n```java\nTokenCredential powerShellCredential = new AzurePowerShellCredentialBuilder()\n .build();\n```\n\n\n[authenticate interactively]: https://learn.microsoft.com/powershell/azure/authenticate-azureps\n[Microsoft Entra ID]: https://learn.microsoft.com/azure/active-directory/fundamentals/"
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
|
|
@ -80,4 +80,4 @@ type: "class"
|
|||
desc: "Represent Options to customize browser view."
|
||||
metadata: {}
|
||||
package: "com.azure.identity"
|
||||
artifact: com.azure:azure-identity:1.11.0
|
||||
artifact: com.azure:azure-identity:1.11.1
|
||||
|
|
|
|||
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче