zio-temporal-core
API
Generated with
zio-temporal-core/zio.temporal/zio.temporal.schedules

zio.temporal.schedules

package zio.temporal.schedules

Members list

Type members

Classlikes

trait ScheduleSpecSyntax

Helper methods for creating schedules

Helper methods for creating schedules

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ZSchedule

A schedule for periodically running an action.

A schedule for periodically running an action.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZSchedule

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ZSchedule.type
sealed trait ZScheduleAction

Base class for an action a schedule can take. See ScheduleActionStartWorkflow for the most commonly used implementation.

Base class for an action a schedule can take. See ScheduleActionStartWorkflow for the most commonly used implementation.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Unknown
object ZScheduleAction

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ZScheduleActionExecution

Base class for an action execution.

Base class for an action execution.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Unknown
object ZScheduleActionExecution

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final class ZScheduleActionResult

Information about when an action took place.

Information about when an action took place.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ZScheduleBackfill(startAt: Instant, endAt: Instant, overlapPolicy: ScheduleOverlapPolicy)

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.

Value parameters

endAt

End of the range to evaluate the schedule in. This is inclusive.

overlapPolicy

Overlap policy to use for this backfill request.

startAt

Start of the range to evaluate the schedule in. This is exclusive.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleBackfill

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZScheduleCalendarSpec

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleCalendarSpec

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final class ZScheduleClient

Represents Temporal schedule client

Represents Temporal schedule client

Attributes

See also

ScheduleClient

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ZScheduleClient

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ZScheduleClientOptions

Represents Temporal schedule client options

Represents Temporal schedule client options

Attributes

See also

ScheduleClientOptions

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleClientOptions extends ConfigurationCompanion[ZScheduleClientOptions]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
final class ZScheduleDescription

Description of a schedule.

Description of a schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final class ZScheduleHandle

Handle for interacting with a schedule.

Handle for interacting with a schedule.

Attributes

See also

ScheduleHandle

Supertypes
class Object
trait Matchable
class Any
final class ZScheduleInfo

Information about a schedule.

Information about a schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ZScheduleIntervalSpec

Specification for scheduling on an interval. Matching times are expressed as

Specification for scheduling on an interval. Matching times are expressed as

epoch + (n * every) + offset.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleIntervalSpec

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ZScheduleListAction

Base class for an action a listed schedule can take.

Base class for an action a listed schedule can take.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Unknown
object ZScheduleListAction

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZScheduleListDescription

Description of a listed schedule.

Description of a listed schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final class ZScheduleListInfo

Information about a listed schedule.

Information about a listed schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final class ZScheduleListSchedule

Details for a listed schedule.

Details for a listed schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final class ZScheduleListState

State of a listed schedule.

State of a listed schedule.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class ZScheduleOptions

Options for creating a schedule.

Options for creating a schedule.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleOptions

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZSchedulePolicy

Policies of a schedule.

Policies of a schedule.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZSchedulePolicy

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZScheduleRange

Inclusive range for a schedule match value.

Inclusive range for a schedule match value.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleRange

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZScheduleSpec

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleSpec

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ZScheduleStartWorkflowStub extends BasicStubOps

Typed schedule start workflow stub that is used to start a scheduled workflow. Allows scheduling a workflow type-safely by invoking the workflow method

Typed schedule start workflow stub that is used to start a scheduled workflow. Allows scheduling a workflow type-safely by invoking the workflow method

Attributes

Companion
object
Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
Known subtypes
object ZScheduleStartWorkflowStub extends ZScheduleStartWorkflowStubSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZScheduleStartWorkflowStubImpl extends ZScheduleStartWorkflowStub

Attributes

Supertypes
trait BasicStubOps
class Object
trait Matchable
class Any
trait ZScheduleStartWorkflowStubSyntax

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ZScheduleStartWorkflowStubSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class ZScheduleState(note: Option[String], paused: Option[Boolean], limitedAction: Option[Boolean], remainingActions: Option[Long])

State of a schedule.

State of a schedule.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleState

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ZScheduleUpdate(schedule: ZSchedule)

An update returned from a schedule updater.

An update returned from a schedule updater.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class ZScheduleUpdateInput(description: ZScheduleDescription)

Parameter passed to a schedule updater.

Parameter passed to a schedule updater.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ZScheduleUpdateInput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Value members

Inherited methods

final def every(value: Duration): ZScheduleIntervalSpec

Creates a schedule interval.

Creates a schedule interval.

Value parameters

value

period to repeat the interval.

Attributes

Inherited from:
ScheduleSpecSyntax
final def range(from: Int, to: Int, by: Int): ZScheduleRange

Create a inclusive range for a schedule match value.

Create a inclusive range for a schedule match value.

Value parameters

by

The step to take between each value. Default if unset or 0, is 1.

from

The inclusive start of the range

to

The inclusive end of the range. Default if unset or less than start is start.

Attributes

Inherited from:
ScheduleSpecSyntax

Inherited fields

final val allMonthDays: List[ZScheduleRange]

Default range set for all days in a month.

Default range set for all days in a month.

Attributes

Inherited from:
ScheduleSpecSyntax
final val allMonths: List[ZScheduleRange]

Default range set for all months in a year.

Default range set for all months in a year.

Attributes

Inherited from:
ScheduleSpecSyntax
final val allWeekDays: List[ZScheduleRange]

Default range set for all days in a week.

Default range set for all days in a week.

Attributes

Inherited from:
ScheduleSpecSyntax
final val calendar: ZScheduleCalendarSpec

Attributes

Inherited from:
ScheduleSpecSyntax
final val weekend: List[ZScheduleRange]

Default range set for weekend days.

Default range set for weekend days.

Attributes

Inherited from:
ScheduleSpecSyntax
Generated with