Class ScheduleHandle

Namespace

Temporalio.Client.Schedules

Assembly

Temporalio.dll

Handle for interacting with a schedule.

public record ScheduleHandle : IEquatable<ScheduleHandle>

Inheritance

object

ScheduleHandle

Implements

IEquatable<ScheduleHandle>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ScheduleHandle(ITemporalClient, string)

Handle for interacting with a schedule.

public ScheduleHandle(ITemporalClient Client, string Id)

Parameters

Client ITemporalClient

Client used for schedule handle calls.

Id string

Schedule ID.

Properties

Client

Client used for schedule handle calls.

public ITemporalClient Client { get; init; }

Property Value

ITemporalClient

Id

Schedule ID.

public string Id { get; init; }

Property Value

string

Methods

BackfillAsync(IReadOnlyCollection<ScheduleBackfill>, RpcOptions?)

Backfill this schedule by going through the specified time periods as if they passed right now.

public Task BackfillAsync(IReadOnlyCollection<ScheduleBackfill> backfills, RpcOptions? rpcOptions = null)

Parameters

backfills IReadOnlyCollection<ScheduleBackfill>

Backfill periods.

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.

DeleteAsync(RpcOptions?)

Delete this schedule.

public Task DeleteAsync(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.

DescribeAsync(RpcOptions?)

Fetch this schedule's description.

public Task<ScheduleDescription> DescribeAsync(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options.

Returns

Task<ScheduleDescription>

Schedule description.

PauseAsync(string?, RpcOptions?)

Pause this schedule.

public Task PauseAsync(string? note = null, RpcOptions? rpcOptions = null)

Parameters

note string

Note to set when pausing.

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.

TriggerAsync(ScheduleTriggerOptions?)

Trigger an action on this schedule to happen immediately.

public Task TriggerAsync(ScheduleTriggerOptions? options = null)

Parameters

options ScheduleTriggerOptions

Options for triggering.

Returns

Task

Task for completion.

UnpauseAsync(string?, RpcOptions?)

Unpause this schedule.

public Task UnpauseAsync(string? note = null, RpcOptions? rpcOptions = null)

Parameters

note string

Note to set when unpausing.

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.

UpdateAsync(Func<ScheduleUpdateInput, Task<ScheduleUpdate?>>, RpcOptions?)

Update this schedule. This is done via a callback which can be called multiple times in case of conflict.

public Task UpdateAsync(Func<ScheduleUpdateInput, Task<ScheduleUpdate?>> updater, RpcOptions? rpcOptions = null)

Parameters

updater Func<ScheduleUpdateInput, Task<ScheduleUpdate>>

Callback to invoke with the current update input. The result can be null to signify no update to perform, or a schedule update instance with a schedule to perform an update.

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.

UpdateAsync(Func<ScheduleUpdateInput, ScheduleUpdate?>, RpcOptions?)

Update this schedule. This is done via a callback which can be called multiple times in case of conflict.

public Task UpdateAsync(Func<ScheduleUpdateInput, ScheduleUpdate?> updater, RpcOptions? rpcOptions = null)

Parameters

updater Func<ScheduleUpdateInput, ScheduleUpdate>

Callback to invoke with the current update input. The result can be null to signify no update to perform, or a schedule update instance with a schedule to perform an update.

rpcOptions RpcOptions

RPC options.

Returns

Task

Task for completion.