-
Notifications
You must be signed in to change notification settings - Fork 260
/
Schedule.xml
242 lines (242 loc) · 14.1 KB
/
Schedule.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
<Type Name="Schedule" FullName="Microsoft.Azure.Batch.Protocol.Models.Schedule">
<TypeSignature Language="C#" Value="public class Schedule" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Schedule extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.Protocol.Models.Schedule" />
<TypeSignature Language="VB.NET" Value="Public Class Schedule" />
<TypeSignature Language="F#" Value="type Schedule = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
<AssemblyVersion>15.3.0.0</AssemblyVersion>
<AssemblyVersion>15.4.0.0</AssemblyVersion>
<AssemblyVersion>16.0.0.0</AssemblyVersion>
<AssemblyVersion>16.1.0.0</AssemblyVersion>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The schedule according to which Jobs will be created. All times are
fixed respective to UTC and are not impacted by daylight saving time.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Schedule ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.Schedule.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the Schedule class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Schedule (DateTime? doNotRunUntil = default, DateTime? doNotRunAfter = default, TimeSpan? startWindow = default, TimeSpan? recurrenceInterval = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<valuetype System.DateTime> doNotRunUntil, valuetype System.Nullable`1<valuetype System.DateTime> doNotRunAfter, valuetype System.Nullable`1<valuetype System.TimeSpan> startWindow, valuetype System.Nullable`1<valuetype System.TimeSpan> recurrenceInterval) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.Protocol.Models.Schedule.#ctor(System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Nullable{System.TimeSpan},System.Nullable{System.TimeSpan})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional doNotRunUntil As Nullable(Of DateTime) = Nothing, Optional doNotRunAfter As Nullable(Of DateTime) = Nothing, Optional startWindow As Nullable(Of TimeSpan) = Nothing, Optional recurrenceInterval As Nullable(Of TimeSpan) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.Protocol.Models.Schedule : Nullable<DateTime> * Nullable<DateTime> * Nullable<TimeSpan> * Nullable<TimeSpan> -> Microsoft.Azure.Batch.Protocol.Models.Schedule" Usage="new Microsoft.Azure.Batch.Protocol.Models.Schedule (doNotRunUntil, doNotRunAfter, startWindow, recurrenceInterval)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="doNotRunUntil" Type="System.Nullable<System.DateTime>" />
<Parameter Name="doNotRunAfter" Type="System.Nullable<System.DateTime>" />
<Parameter Name="startWindow" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="recurrenceInterval" Type="System.Nullable<System.TimeSpan>" />
</Parameters>
<Docs>
<param name="doNotRunUntil">The earliest time at which any Job may
be created under this Job Schedule.</param>
<param name="doNotRunAfter">A time after which no Job will be
created under this Job Schedule. The schedule will move to the
completed state as soon as this deadline is past and there is no
active Job under this Job Schedule.</param>
<param name="startWindow">The time interval, starting from the time
at which the schedule indicates a Job should be created, within
which a Job must be created.</param>
<param name="recurrenceInterval">The time interval between the
start times of two successive Jobs under the Job Schedule. A Job
Schedule can have at most one active Job under it at any given
time.</param>
<summary>
Initializes a new instance of the Schedule class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DoNotRunAfter">
<MemberSignature Language="C#" Value="public DateTime? DoNotRunAfter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> DoNotRunAfter" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.Schedule.DoNotRunAfter" />
<MemberSignature Language="VB.NET" Value="Public Property DoNotRunAfter As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.DoNotRunAfter : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.Schedule.DoNotRunAfter" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="doNotRunAfter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="doNotRunAfter")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a time after which no Job will be created under this
Job Schedule. The schedule will move to the completed state as soon
as this deadline is past and there is no active Job under this Job
Schedule.
</summary>
<value>To be added.</value>
<remarks>
If you do not specify a doNotRunAfter time, and you are creating a
recurring Job Schedule, the Job Schedule will remain active until
you explicitly terminate it.
</remarks>
</Docs>
</Member>
<Member MemberName="DoNotRunUntil">
<MemberSignature Language="C#" Value="public DateTime? DoNotRunUntil { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> DoNotRunUntil" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.Schedule.DoNotRunUntil" />
<MemberSignature Language="VB.NET" Value="Public Property DoNotRunUntil As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.DoNotRunUntil : Nullable<DateTime> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.Schedule.DoNotRunUntil" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="doNotRunUntil")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="doNotRunUntil")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the earliest time at which any Job may be created
under this Job Schedule.
</summary>
<value>To be added.</value>
<remarks>
If you do not specify a doNotRunUntil time, the schedule becomes
ready to create Jobs immediately.
</remarks>
</Docs>
</Member>
<Member MemberName="RecurrenceInterval">
<MemberSignature Language="C#" Value="public TimeSpan? RecurrenceInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> RecurrenceInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.Schedule.RecurrenceInterval" />
<MemberSignature Language="VB.NET" Value="Public Property RecurrenceInterval As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.RecurrenceInterval : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.Schedule.RecurrenceInterval" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="recurrenceInterval")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="recurrenceInterval")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the time interval between the start times of two
successive Jobs under the Job Schedule. A Job Schedule can have at
most one active Job under it at any given time.
</summary>
<value>To be added.</value>
<remarks>
Because a Job Schedule can have at most one active Job under it at
any given time, if it is time to create a new Job under a Job
Schedule, but the previous Job is still running, the Batch service
will not create the new Job until the previous Job finishes. If the
previous Job does not finish within the startWindow period of the
new recurrenceInterval, then no new Job will be scheduled for that
interval. For recurring Jobs, you should normally specify a
jobManagerTask in the jobSpecification. If you do not use
jobManagerTask, you will need an external process to monitor when
Jobs are created, add Tasks to the Jobs and terminate the Jobs
ready for the next recurrence. The default is that the schedule
does not recur: one Job is created, within the startWindow after
the doNotRunUntil time, and the schedule is complete as soon as
that Job finishes. The minimum value is 1 minute. If you specify a
lower value, the Batch service rejects the schedule with an error;
if you are calling the REST API directly, the HTTP status code is
400 (Bad Request).
</remarks>
</Docs>
</Member>
<Member MemberName="StartWindow">
<MemberSignature Language="C#" Value="public TimeSpan? StartWindow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> StartWindow" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.Protocol.Models.Schedule.StartWindow" />
<MemberSignature Language="VB.NET" Value="Public Property StartWindow As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.StartWindow : Nullable<TimeSpan> with get, set" Usage="Microsoft.Azure.Batch.Protocol.Models.Schedule.StartWindow" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="startWindow")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="startWindow")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the time interval, starting from the time at which the
schedule indicates a Job should be created, within which a Job must
be created.
</summary>
<value>To be added.</value>
<remarks>
If a Job is not created within the startWindow interval, then the
'opportunity' is lost; no Job will be created until the next
recurrence of the schedule. If the schedule is recurring, and the
startWindow is longer than the recurrence interval, then this is
equivalent to an infinite startWindow, because the Job that is
'due' in one recurrenceInterval is not carried forward into the
next recurrence interval. The default is infinite. The minimum
value is 1 minute. If you specify a lower value, the Batch service
rejects the schedule with an error; if you are calling the REST API
directly, the HTTP status code is 400 (Bad Request).
</remarks>
</Docs>
</Member>
</Members>
</Type>