TimerJobUtility.ResumeGranularity property

Gets or sets the granularity at which the timer job will be resumed.

Namespace:  Microsoft.Office.Server.Utilities
Assembly:  Microsoft.Office.Server (in Microsoft.Office.Server.dll)

Syntax

'Declaration
Public Property ResumeGranularity As IterationGranularity
    Get
    Set
'Usage
Dim instance As TimerJobUtility
Dim value As IterationGranularity

value = instance.ResumeGranularity

instance.ResumeGranularity = value
public IterationGranularity ResumeGranularity { get; set; }

Property value

Type: Microsoft.Office.Server.Utilities.IterationGranularity
Returns IterationGranularity.

Remarks

ResumeGranularity must be a scope that is greater than or equal to CancellationGranularity.

Having a ResumeGranularity scope larger than the CancellationGranularity allows your job to respond to pause or cancel requests more quickly at the expense of reprocessing some of the work already accomplished when the job is resumed. For example, it may make sense to have CancellationGranularity set to IterationGranularity.Item but set ResumeGranularity to IterationGranularity.List. This means that the TimerJobUtility class will only track the state of the timer job at the list level (which means less updates of the JobState property) but the job can be cancelled in the middle of processing a list. An example of where this would make sense is if the timer job uses a query to determine which items to process and items that are already processed no longer satisfy the query, then there is no need to support resume at the item scope since resuming at the list scope will not require any items to be reprocessed.

See also

Reference

TimerJobUtility class

TimerJobUtility members

Microsoft.Office.Server.Utilities namespace