RouterWorker Class

Definition

An entity for jobs to be routed to.

public class RouterWorker
public class RouterWorker : System.ClientModel.Primitives.IJsonModel<Azure.Communication.JobRouter.RouterWorker>, System.ClientModel.Primitives.IPersistableModel<Azure.Communication.JobRouter.RouterWorker>
type RouterWorker = class
type RouterWorker = class
    interface IJsonModel<RouterWorker>
    interface IPersistableModel<RouterWorker>
Public Class RouterWorker
Public Class RouterWorker
Implements IJsonModel(Of RouterWorker), IPersistableModel(Of RouterWorker)
Inheritance
RouterWorker
Implements

Constructors

RouterWorker(String)

Initializes a new instance of a worker.

Properties

AssignedJobs

A list of assigned jobs attached to this worker.

AvailableForOffers

A flag indicating whether this worker is open to receive offers or not.

Capacity

The total capacity score this worker has to manage multiple concurrent jobs.

Channels

Collection of channel(s) this worker can handle and their impact on the workers capacity.

ETag

The entity tag for this resource.

Id

Id of a worker.

Labels

A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean.

LoadRatio

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.

MaxConcurrentOffers

If this is set, the worker will only receive up to this many new offers at a time.

Offers

A list of active offers issued to this worker.

Queues

Collection of queue(s) that this worker can receive work from.

State

Current state of a worker.

Tags

A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean.

Explicit Interface Implementations

IJsonModel<RouterWorker>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<RouterWorker>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<RouterWorker>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RouterWorker>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<RouterWorker>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to