-
Notifications
You must be signed in to change notification settings - Fork 244
/
com.microsoft.azure.batch.protocol.models.CloudJobSchedule.yml
395 lines (395 loc) · 28.8 KB
/
com.microsoft.azure.batch.protocol.models.CloudJobSchedule.yml
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule"
name: "CloudJobSchedule"
nameWithType: "CloudJobSchedule"
summary: "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job."
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 class **CloudJobSchedule**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.CloudJobSchedule()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.CloudJobSchedule()"
name: "CloudJobSchedule()"
nameWithType: "CloudJobSchedule.CloudJobSchedule()"
syntax: "public CloudJobSchedule()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.creationTime()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.creationTime()"
name: "creationTime()"
nameWithType: "CloudJobSchedule.creationTime()"
summary: "Get the creation<wbr>Time value."
syntax: "public DateTime creationTime()"
desc: "Get the creationTime value."
returns:
description: "the creationTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.displayName()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.displayName()"
name: "displayName()"
nameWithType: "CloudJobSchedule.displayName()"
summary: "Get the display<wbr>Name value."
syntax: "public String displayName()"
desc: "Get the displayName value."
returns:
description: "the displayName value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.eTag()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.eTag()"
name: "eTag()"
nameWithType: "CloudJobSchedule.eTag()"
summary: "Get this is an opaque string."
syntax: "public String eTag()"
desc: "Get this is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime."
returns:
description: "the eTag value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.executionInfo()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.executionInfo()"
name: "executionInfo()"
nameWithType: "CloudJobSchedule.executionInfo()"
summary: "Get the execution<wbr>Info value."
syntax: "public JobScheduleExecutionInformation executionInfo()"
desc: "Get the executionInfo value."
returns:
description: "the executionInfo value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleExecutionInformation?alt=com.microsoft.azure.batch.protocol.models.JobScheduleExecutionInformation&text=JobScheduleExecutionInformation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.id()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.id()"
name: "id()"
nameWithType: "CloudJobSchedule.id()"
summary: "Get the id value."
syntax: "public String id()"
desc: "Get the id value."
returns:
description: "the id value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.jobSpecification()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.jobSpecification()"
name: "jobSpecification()"
nameWithType: "CloudJobSchedule.jobSpecification()"
summary: "Get the job<wbr>Specification value."
syntax: "public JobSpecification jobSpecification()"
desc: "Get the jobSpecification value."
returns:
description: "the jobSpecification value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.lastModified()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.lastModified()"
name: "lastModified()"
nameWithType: "CloudJobSchedule.lastModified()"
summary: "Get this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed."
syntax: "public DateTime lastModified()"
desc: "Get this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state."
returns:
description: "the lastModified value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.metadata()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.metadata()"
name: "metadata()"
nameWithType: "CloudJobSchedule.metadata()"
summary: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
syntax: "public List<MetadataItem> metadata()"
desc: "Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the metadata value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.previousState()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.previousState()"
name: "previousState()"
nameWithType: "CloudJobSchedule.previousState()"
summary: "Get this property is not present if the Job Schedule is in its initial active state."
syntax: "public JobScheduleState previousState()"
desc: "Get this property is not present if the Job Schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
returns:
description: "the previousState value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleState?alt=com.microsoft.azure.batch.protocol.models.JobScheduleState&text=JobScheduleState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.previousStateTransitionTime()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.previousStateTransitionTime()"
name: "previousStateTransitionTime()"
nameWithType: "CloudJobSchedule.previousStateTransitionTime()"
summary: "Get this property is not present if the Job Schedule is in its initial active state."
syntax: "public DateTime previousStateTransitionTime()"
desc: "Get this property is not present if the Job Schedule is in its initial active state."
returns:
description: "the previousStateTransitionTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.schedule()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.schedule()"
name: "schedule()"
nameWithType: "CloudJobSchedule.schedule()"
summary: "Get all times are fixed respective to UTC and are not impacted by daylight saving time."
syntax: "public Schedule schedule()"
desc: "Get all times are fixed respective to UTC and are not impacted by daylight saving time."
returns:
description: "the schedule value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.Schedule?alt=com.microsoft.azure.batch.protocol.models.Schedule&text=Schedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.state()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.state()"
name: "state()"
nameWithType: "CloudJobSchedule.state()"
summary: "Get possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
syntax: "public JobScheduleState state()"
desc: "Get possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
returns:
description: "the state value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleState?alt=com.microsoft.azure.batch.protocol.models.JobScheduleState&text=JobScheduleState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.stateTransitionTime()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.stateTransitionTime()"
name: "stateTransitionTime()"
nameWithType: "CloudJobSchedule.stateTransitionTime()"
summary: "Get the state<wbr>Transition<wbr>Time value."
syntax: "public DateTime stateTransitionTime()"
desc: "Get the stateTransitionTime value."
returns:
description: "the stateTransitionTime value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.stats()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.stats()"
name: "stats()"
nameWithType: "CloudJobSchedule.stats()"
summary: "Get the stats value."
syntax: "public JobScheduleStatistics stats()"
desc: "Get the stats value."
returns:
description: "the stats value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleStatistics?alt=com.microsoft.azure.batch.protocol.models.JobScheduleStatistics&text=JobScheduleStatistics\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.url()"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.url()"
name: "url()"
nameWithType: "CloudJobSchedule.url()"
summary: "Get the url value."
syntax: "public String url()"
desc: "Get the url value."
returns:
description: "the url value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withCreationTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withCreationTime(DateTime creationTime)"
name: "withCreationTime(DateTime creationTime)"
nameWithType: "CloudJobSchedule.withCreationTime(DateTime creationTime)"
summary: "Set the creation<wbr>Time value."
parameters:
- description: "the creationTime value to set"
name: "creationTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withCreationTime(DateTime creationTime)"
desc: "Set the creationTime value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withDisplayName(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withDisplayName(String displayName)"
name: "withDisplayName(String displayName)"
nameWithType: "CloudJobSchedule.withDisplayName(String displayName)"
summary: "Set the display<wbr>Name value."
parameters:
- description: "the displayName value to set"
name: "displayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CloudJobSchedule withDisplayName(String displayName)"
desc: "Set the displayName value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withETag(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withETag(String eTag)"
name: "withETag(String eTag)"
nameWithType: "CloudJobSchedule.withETag(String eTag)"
summary: "Set this is an opaque string."
parameters:
- description: "the eTag value to set"
name: "eTag"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CloudJobSchedule withETag(String eTag)"
desc: "Set this is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withExecutionInfo(com.microsoft.azure.batch.protocol.models.JobScheduleExecutionInformation)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withExecutionInfo(JobScheduleExecutionInformation executionInfo)"
name: "withExecutionInfo(JobScheduleExecutionInformation executionInfo)"
nameWithType: "CloudJobSchedule.withExecutionInfo(JobScheduleExecutionInformation executionInfo)"
summary: "Set the execution<wbr>Info value."
parameters:
- description: "the executionInfo value to set"
name: "executionInfo"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleExecutionInformation?alt=com.microsoft.azure.batch.protocol.models.JobScheduleExecutionInformation&text=JobScheduleExecutionInformation\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withExecutionInfo(JobScheduleExecutionInformation executionInfo)"
desc: "Set the executionInfo value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withId(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withId(String id)"
name: "withId(String id)"
nameWithType: "CloudJobSchedule.withId(String id)"
summary: "Set the id value."
parameters:
- description: "the id value to set"
name: "id"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CloudJobSchedule withId(String id)"
desc: "Set the id value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withJobSpecification(com.microsoft.azure.batch.protocol.models.JobSpecification)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withJobSpecification(JobSpecification jobSpecification)"
name: "withJobSpecification(JobSpecification jobSpecification)"
nameWithType: "CloudJobSchedule.withJobSpecification(JobSpecification jobSpecification)"
summary: "Set the job<wbr>Specification value."
parameters:
- description: "the jobSpecification value to set"
name: "jobSpecification"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobSpecification?alt=com.microsoft.azure.batch.protocol.models.JobSpecification&text=JobSpecification\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withJobSpecification(JobSpecification jobSpecification)"
desc: "Set the jobSpecification value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withLastModified(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withLastModified(DateTime lastModified)"
name: "withLastModified(DateTime lastModified)"
nameWithType: "CloudJobSchedule.withLastModified(DateTime lastModified)"
summary: "Set this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed."
parameters:
- description: "the lastModified value to set"
name: "lastModified"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withLastModified(DateTime lastModified)"
desc: "Set this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withMetadata(java.util.List<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withMetadata(List<MetadataItem> metadata)"
name: "withMetadata(List<MetadataItem> metadata)"
nameWithType: "CloudJobSchedule.withMetadata(List<MetadataItem> metadata)"
summary: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
parameters:
- description: "the metadata value to set"
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public CloudJobSchedule withMetadata(List<MetadataItem> metadata)"
desc: "Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withPreviousState(com.microsoft.azure.batch.protocol.models.JobScheduleState)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withPreviousState(JobScheduleState previousState)"
name: "withPreviousState(JobScheduleState previousState)"
nameWithType: "CloudJobSchedule.withPreviousState(JobScheduleState previousState)"
summary: "Set this property is not present if the Job Schedule is in its initial active state."
parameters:
- description: "the previousState value to set"
name: "previousState"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleState?alt=com.microsoft.azure.batch.protocol.models.JobScheduleState&text=JobScheduleState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withPreviousState(JobScheduleState previousState)"
desc: "Set this property is not present if the Job Schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withPreviousStateTransitionTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
name: "withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
nameWithType: "CloudJobSchedule.withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
summary: "Set this property is not present if the Job Schedule is in its initial active state."
parameters:
- description: "the previousStateTransitionTime value to set"
name: "previousStateTransitionTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withPreviousStateTransitionTime(DateTime previousStateTransitionTime)"
desc: "Set this property is not present if the Job Schedule is in its initial active state."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withSchedule(com.microsoft.azure.batch.protocol.models.Schedule)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withSchedule(Schedule schedule)"
name: "withSchedule(Schedule schedule)"
nameWithType: "CloudJobSchedule.withSchedule(Schedule schedule)"
summary: "Set all times are fixed respective to UTC and are not impacted by daylight saving time."
parameters:
- description: "the schedule value to set"
name: "schedule"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.Schedule?alt=com.microsoft.azure.batch.protocol.models.Schedule&text=Schedule\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withSchedule(Schedule schedule)"
desc: "Set all times are fixed respective to UTC and are not impacted by daylight saving time."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withState(com.microsoft.azure.batch.protocol.models.JobScheduleState)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withState(JobScheduleState state)"
name: "withState(JobScheduleState state)"
nameWithType: "CloudJobSchedule.withState(JobScheduleState state)"
summary: "Set possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
parameters:
- description: "the state value to set"
name: "state"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleState?alt=com.microsoft.azure.batch.protocol.models.JobScheduleState&text=JobScheduleState\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withState(JobScheduleState state)"
desc: "Set possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withStateTransitionTime(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withStateTransitionTime(DateTime stateTransitionTime)"
name: "withStateTransitionTime(DateTime stateTransitionTime)"
nameWithType: "CloudJobSchedule.withStateTransitionTime(DateTime stateTransitionTime)"
summary: "Set the state<wbr>Transition<wbr>Time value."
parameters:
- description: "the stateTransitionTime value to set"
name: "stateTransitionTime"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withStateTransitionTime(DateTime stateTransitionTime)"
desc: "Set the stateTransitionTime value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withStats(com.microsoft.azure.batch.protocol.models.JobScheduleStatistics)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withStats(JobScheduleStatistics stats)"
name: "withStats(JobScheduleStatistics stats)"
nameWithType: "CloudJobSchedule.withStats(JobScheduleStatistics stats)"
summary: "Set the stats value."
parameters:
- description: "the stats value to set"
name: "stats"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobScheduleStatistics?alt=com.microsoft.azure.batch.protocol.models.JobScheduleStatistics&text=JobScheduleStatistics\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CloudJobSchedule withStats(JobScheduleStatistics stats)"
desc: "Set the stats value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withUrl(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.CloudJobSchedule.withUrl(String url)"
name: "withUrl(String url)"
nameWithType: "CloudJobSchedule.withUrl(String url)"
summary: "Set the url value."
parameters:
- description: "the url value to set"
name: "url"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CloudJobSchedule withUrl(String url)"
desc: "Set the url value."
returns:
description: "the CloudJobSchedule object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.CloudJobSchedule?alt=com.microsoft.azure.batch.protocol.models.CloudJobSchedule&text=CloudJobSchedule\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.1.1