TimeProperties object. The UtcTimePropertiesBuilder allows callers to create an instance ITimeProperties in UTC. The constraint is a combination of a start time and an execution window. For instance, if we want the EPG sync task to be executed between 2AM and 4AM UTC, then the timeProperties can be built as UtcTimePropertiesBuilder.startHour(2).startMinute(0).startSecond(0).executionWindowInMinutes(120).build();
Extends
Constructors
new UtcTimePropertiesBuilder()
new UtcTimePropertiesBuilder():UtcTimePropertiesBuilder
Returns
UtcTimePropertiesBuilder
Inherited from
Builder.constructor
Methods
build()
build():ITimeProperties
Builds the TimeProperties object based on the parameters provided.
Returns
ITimeProperties
The built TimeProperties object.
Throws
InvalidArgumentError if one or more of the required fields are missing.
Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Overrides
Builder.build
executionWindowInMinutes()
executionWindowInMinutes(window): UtcTimePropertiesBuilder
Sets the length of the execution time window in the TimeProperties.
Parameters
window
number
The length of the execution time window in mins.
Returns
UtcTimePropertiesBuilder
The UtcTimePropertiesBuilder object with the execution window set.
Details
This field is optional for the time properties. The default value is 60 mins.Throws
IllegalStateError if the function is called after this builder instance
has already built an object once.
Throws
InvalidArgumentError if the execution window is smaller than 1 hour.
