135 строки
13 KiB
YAML
135 строки
13 KiB
YAML
### 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.1.7
|