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