package schedules
- Alphabetic
- By Inheritance
- schedules
- ScheduleSpecSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- trait ScheduleSpecSyntax extends AnyRef
Helper methods for creating schedules
- final case class ZSchedule extends Product with Serializable
A schedule for periodically running an action.
- sealed trait ZScheduleAction extends AnyRef
Base class for an action a schedule can take.
Base class for an action a schedule can take. See ScheduleActionStartWorkflow for the most commonly used implementation.
- sealed trait ZScheduleActionExecution extends AnyRef
Base class for an action execution.
- final class ZScheduleActionResult extends AnyRef
Information about when an action took place.
- final case class ZScheduleBackfill(startAt: Instant, endAt: Instant, overlapPolicy: ScheduleOverlapPolicy = ScheduleOverlapPolicy.SCHEDULE_OVERLAP_POLICY_UNSPECIFIED) extends Product with Serializable
Time period and policy for actions taken as if their scheduled time has already passed.
Time period and policy for actions taken as if their scheduled time has already passed.
- startAt
Start of the range to evaluate the schedule in. This is exclusive.
- endAt
End of the range to evaluate the schedule in. This is inclusive.
- overlapPolicy
Overlap policy to use for this backfill request.
- final case class ZScheduleCalendarSpec extends Product with Serializable
Specification of when to run an action in relation to calendar time.
Specification of when to run an action in relation to calendar time.
A timestamp matches if at least one range of each field matches except for year. If year is missing, that means all years match. For all fields besides year, at least one range must be present to match anything.
- final class ZScheduleClient extends AnyRef
Represents Temporal schedule client
Represents Temporal schedule client
- See also
ScheduleClient
- final case class ZScheduleClientOptions extends Product with Serializable
Represents Temporal schedule client options
Represents Temporal schedule client options
- See also
ScheduleClientOptions
- final class ZScheduleDescription extends AnyRef
Description of a schedule.
- final class ZScheduleHandle extends AnyRef
Handle for interacting with a schedule.
Handle for interacting with a schedule.
- See also
ScheduleHandle
- final class ZScheduleInfo extends AnyRef
Information about a schedule.
- final case class ZScheduleIntervalSpec extends Product with Serializable
Specification for scheduling on an interval.
Specification for scheduling on an interval. Matching times are expressed as
epoch + (n * every) + offset.
- sealed trait ZScheduleListAction extends AnyRef
Base class for an action a listed schedule can take.
- final class ZScheduleListDescription extends AnyRef
Description of a listed schedule.
- final class ZScheduleListInfo extends AnyRef
Information about a listed schedule.
- final class ZScheduleListSchedule extends AnyRef
Details for a listed schedule.
- final class ZScheduleListState extends AnyRef
State of a listed schedule.
- final case class ZScheduleOptions extends Product with Serializable
Options for creating a schedule.
- final case class ZSchedulePolicy extends Product with Serializable
Policies of a schedule.
- final case class ZScheduleRange extends Product with Serializable
Inclusive range for a schedule match value.
- final case class ZScheduleSpec extends Product with Serializable
Specification of the times scheduled actions may occur.
Specification of the times scheduled actions may occur.
The times is a union represented as ZScheduleSpec.Times type. ZScheduleSpec.skip is used for exclusions
- sealed trait ZScheduleStartWorkflowStub extends BasicStubOps
Typed schedule start workflow stub that is used to start a scheduled workflow.
Typed schedule start workflow stub that is used to start a scheduled workflow. Allows scheduling a workflow type-safely by invoking the workflow method
- final class ZScheduleStartWorkflowStubImpl extends ZScheduleStartWorkflowStub
- trait ZScheduleStartWorkflowStubSyntax extends AnyRef
- final case class ZScheduleState(note: Option[String], paused: Option[Boolean], limitedAction: Option[Boolean], remainingActions: Option[Long]) extends Product with Serializable
State of a schedule.
- final case class ZScheduleUpdate(schedule: ZSchedule) extends Product with Serializable
An update returned from a schedule updater.
- final case class ZScheduleUpdateInput(description: ZScheduleDescription) extends Product with Serializable
Parameter passed to a schedule updater.
Value Members
- final val allMonthDays: List[ZScheduleRange]
Default range set for all days in a month.
Default range set for all days in a month.
- Definition Classes
- ScheduleSpecSyntax
- final val allMonths: List[ZScheduleRange]
Default range set for all months in a year.
Default range set for all months in a year.
- Definition Classes
- ScheduleSpecSyntax
- final val allWeekDays: List[ZScheduleRange]
Default range set for all days in a week.
Default range set for all days in a week.
- Definition Classes
- ScheduleSpecSyntax
- final val calendar: ZScheduleCalendarSpec
- Definition Classes
- ScheduleSpecSyntax
- final def every(value: zio.Duration): ZScheduleIntervalSpec
Creates a schedule interval.
Creates a schedule interval.
- value
period to repeat the interval.
- Definition Classes
- ScheduleSpecSyntax
- final def range(from: Int = 0, to: Int = 0, by: Int = 0): ZScheduleRange
Create a inclusive range for a schedule match value.
Create a inclusive range for a schedule match value.
- from
The inclusive start of the range
- to
The inclusive end of the range. Default if unset or less than start is start.
- by
The step to take between each value. Default if unset or 0, is 1.
- Definition Classes
- ScheduleSpecSyntax
- final val weekend: List[ZScheduleRange]
Default range set for weekend days.
Default range set for weekend days.
- Definition Classes
- ScheduleSpecSyntax
- object ZSchedule extends Serializable
- object ZScheduleAction
- object ZScheduleActionExecution
- object ZScheduleBackfill extends Serializable
- object ZScheduleCalendarSpec extends Serializable
- object ZScheduleClient
- object ZScheduleClientOptions extends ConfigurationCompanion[ZScheduleClientOptions] with Serializable
- object ZScheduleIntervalSpec extends Serializable
- object ZScheduleListAction
- object ZScheduleOptions extends Serializable
- object ZSchedulePolicy extends Serializable
- object ZScheduleRange extends Serializable
- object ZScheduleSpec extends Serializable
- object ZScheduleStartWorkflowStub extends Stubs[ZScheduleStartWorkflowStub] with ZScheduleStartWorkflowStubSyntax
- object ZScheduleState extends Serializable
- object ZScheduleUpdateInput extends Serializable