-
Notifications
You must be signed in to change notification settings - Fork 257
/
CreateWorkerOptions.xml
249 lines (249 loc) · 14.2 KB
/
CreateWorkerOptions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<Type Name="CreateWorkerOptions" FullName="Azure.Communication.JobRouter.CreateWorkerOptions">
<TypeSignature Language="C#" Value="public class CreateWorkerOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CreateWorkerOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Communication.JobRouter.CreateWorkerOptions" />
<TypeSignature Language="VB.NET" Value="Public Class CreateWorkerOptions" />
<TypeSignature Language="F#" Value="type CreateWorkerOptions = class" />
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options for creating a worker.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CreateWorkerOptions (string workerId, int capacity);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string workerId, int32 capacity) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.JobRouter.CreateWorkerOptions.#ctor(System.String,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (workerId As String, capacity As Integer)" />
<MemberSignature Language="F#" Value="new Azure.Communication.JobRouter.CreateWorkerOptions : string * int -> Azure.Communication.JobRouter.CreateWorkerOptions" Usage="new Azure.Communication.JobRouter.CreateWorkerOptions (workerId, capacity)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="workerId" Type="System.String" />
<Parameter Name="capacity" Type="System.Int32" />
</Parameters>
<Docs>
<param name="workerId"> Id of a worker. </param>
<param name="capacity"> The total capacity score this worker has to manage multiple concurrent jobs. </param>
<summary>
Initializes a new instance of CreateWorkerOptions.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="workerId" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="AvailableForOffers">
<MemberSignature Language="C#" Value="public bool AvailableForOffers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AvailableForOffers" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.AvailableForOffers" />
<MemberSignature Language="VB.NET" Value="Public Property AvailableForOffers As Boolean" />
<MemberSignature Language="F#" Value="member this.AvailableForOffers : bool with get, set" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.AvailableForOffers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> A flag indicating whether this worker is open to receive offers or not. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Capacity">
<MemberSignature Language="C#" Value="public int Capacity { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Capacity" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.Capacity" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Capacity As Integer" />
<MemberSignature Language="F#" Value="member this.Capacity : int" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.Capacity" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The total capacity score this worker has to manage multiple concurrent jobs.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Channels">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Azure.Communication.JobRouter.RouterChannel> Channels { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Azure.Communication.JobRouter.RouterChannel> Channels" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.Channels" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Channels As IList(Of RouterChannel)" />
<MemberSignature Language="F#" Value="member this.Channels : System.Collections.Generic.IList<Azure.Communication.JobRouter.RouterChannel>" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.Channels" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Azure.Communication.JobRouter.RouterChannel></ReturnType>
</ReturnValue>
<Docs>
<summary> Collection of channel(s) this worker can handle and their impact on the workers capacity. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Labels">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,Azure.Communication.JobRouter.RouterValue> Labels { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, class Azure.Communication.JobRouter.RouterValue> Labels" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.Labels" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Labels As IDictionary(Of String, RouterValue)" />
<MemberSignature Language="F#" Value="member this.Labels : System.Collections.Generic.IDictionary<string, Azure.Communication.JobRouter.RouterValue>" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.Labels" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,Azure.Communication.JobRouter.RouterValue></ReturnType>
</ReturnValue>
<Docs>
<summary>
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.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxConcurrentOffers">
<MemberSignature Language="C#" Value="public int? MaxConcurrentOffers { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxConcurrentOffers" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.MaxConcurrentOffers" />
<MemberSignature Language="VB.NET" Value="Public Property MaxConcurrentOffers As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxConcurrentOffers : Nullable<int> with get, set" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.MaxConcurrentOffers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary> If this is set, the worker will only receive up to this many new offers at a time. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Queues">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> Queues { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> Queues" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.Queues" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Queues As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.Queues : System.Collections.Generic.IList<string>" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.Queues" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary> Collection of queue(s) that this worker can receive work from. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestConditions">
<MemberSignature Language="C#" Value="public Azure.RequestConditions RequestConditions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.RequestConditions RequestConditions" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.RequestConditions" />
<MemberSignature Language="VB.NET" Value="Public Property RequestConditions As RequestConditions" />
<MemberSignature Language="F#" Value="member this.RequestConditions : Azure.RequestConditions with get, set" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.RequestConditions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.RequestConditions</ReturnType>
</ReturnValue>
<Docs>
<summary>
The content to send as the request conditions of the request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tags">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,Azure.Communication.JobRouter.RouterValue> Tags { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, class Azure.Communication.JobRouter.RouterValue> Tags" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.Tags" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Tags As IDictionary(Of String, RouterValue)" />
<MemberSignature Language="F#" Value="member this.Tags : System.Collections.Generic.IDictionary<string, Azure.Communication.JobRouter.RouterValue>" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.Tags" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,Azure.Communication.JobRouter.RouterValue></ReturnType>
</ReturnValue>
<Docs>
<summary>
A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WorkerId">
<MemberSignature Language="C#" Value="public string WorkerId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string WorkerId" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.JobRouter.CreateWorkerOptions.WorkerId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property WorkerId As String" />
<MemberSignature Language="F#" Value="member this.WorkerId : string" Usage="Azure.Communication.JobRouter.CreateWorkerOptions.WorkerId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.JobRouter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Id of a worker.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>