次の方法で共有

Schedule Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.1.1
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.Schedule

public class Schedule

The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.

Constructor Summary

Constructor Description
Schedule()

Method Summary

Modifier and Type Method and Description
org.joda.time.DateTime doNotRunAfter()

Get 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.
org.joda.time.DateTime doNotRunUntil()

Get if you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately.
org.joda.time.Period recurrenceInterval()

Get 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.
org.joda.time.Period startWindow()

Get 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.
Schedule withDoNotRunAfter(DateTime doNotRunAfter)

Set 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.
Schedule withDoNotRunUntil(DateTime doNotRunUntil)

Set if you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately.
Schedule withRecurrenceInterval(Period recurrenceInterval)

Set 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.
Schedule withStartWindow(Period startWindow)

Set 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.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Schedule

public Schedule()

Method Details

doNotRunAfter

public DateTime doNotRunAfter()

Get 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.

Returns:

the doNotRunAfter value

doNotRunUntil

public DateTime doNotRunUntil()

Get if you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately.

Returns:

the doNotRunUntil value

recurrenceInterval

public Period recurrenceInterval()

Get 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).

Returns:

the recurrenceInterval value

startWindow

public Period startWindow()

Get 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).

Returns:

the startWindow value

withDoNotRunAfter

public Schedule withDoNotRunAfter(DateTime doNotRunAfter)

Set 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.

Parameters:

doNotRunAfter - the doNotRunAfter value to set

Returns:

the Schedule object itself.

withDoNotRunUntil

public Schedule withDoNotRunUntil(DateTime doNotRunUntil)

Set if you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately.

Parameters:

doNotRunUntil - the doNotRunUntil value to set

Returns:

the Schedule object itself.

withRecurrenceInterval

public Schedule withRecurrenceInterval(Period recurrenceInterval)

Set 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).

Parameters:

recurrenceInterval - the recurrenceInterval value to set

Returns:

the Schedule object itself.

withStartWindow

public Schedule withStartWindow(Period startWindow)

Set 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).

Parameters:

startWindow - the startWindow value to set

Returns:

the Schedule object itself.

Applies to