updatabletimerv1xns

package
v1.14.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 6, 2025 License: MIT Imports: 18 Imported by: 0

Documentation

Overview

Code generated by protoc-gen-go_temporal. DO NOT EDIT. versions: 

protoc-gen-go_temporal 1.14.5-next (aaaee0598037e11b0806304140622344c324d0ac)
go go1.23.4
protoc (unknown)

source: example/updatabletimer/v1/updatabletimer.proto

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CancelExampleWorkflow 

func CancelExampleWorkflow(ctx workflow.Context, workflowID string, runID string) error

CancelExampleWorkflow cancels an existing workflow

func CancelExampleWorkflowAsync 

func CancelExampleWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future

CancelExampleWorkflowAsync cancels an existing workflow

func GetWakeUpTime 

func GetWakeUpTime(ctx workflow.Context, workflowID string, runID string, opts ...*GetWakeUpTimeQueryOptions) (*v1.GetWakeUpTimeOutput, error)

GetWakeUpTime retrieves the current timer expiration timestamp

func RegisterExampleActivities 

func RegisterExampleActivities(r worker.ActivityRegistry, c v1.ExampleClient, options ...*ExampleOptions)

RegisterExampleActivities registers example.updatabletimer.v1.Example cross-namespace activities

func UpdatableTimer 

func UpdatableTimer(ctx workflow.Context, req *v1.UpdatableTimerInput, opts ...*UpdatableTimerWorkflowOptions) error

UpdatableTimer describes an updatable timer workflow

func UpdateWakeUpTime 

func UpdateWakeUpTime(ctx workflow.Context, workflowID string, runID string, req *v1.UpdateWakeUpTimeInput, opts ...*UpdateWakeUpTimeSignalOptions) error

UpdateWakeUpTime updates the timer expiration timestamp

Types

type ExampleOptions 

type ExampleOptions struct {
	// contains filtered or unexported fields
}

ExampleOptions is used to configure example.updatabletimer.v1.Example xns activity registration

func NewExampleOptions added in v1.10.4 

func NewExampleOptions() *ExampleOptions

NewExampleOptions initializes a new ExampleOptions value

func (*ExampleOptions) WithErrorConverter added in v1.10.4 

func (opts *ExampleOptions) WithErrorConverter(errorConverter func(error) error) *ExampleOptions

WithErrorConverter overrides the default error converter applied to xns activity errors

func (*ExampleOptions) WithFilter added in v1.10.4 

func (opts *ExampleOptions) WithFilter(filter func(string) string) *ExampleOptions

Filter is used to filter registered xns activities or customize their name

type GetWakeUpTimeQueryHandle 

type GetWakeUpTimeQueryHandle interface {
	// Cancel cancels the workflow
	Cancel(workflow.Context) error

	// Future returns the inner workflow.Future
	Future() workflow.Future

	// Get returns the inner workflow.Future
	Get(workflow.Context) (*v1.GetWakeUpTimeOutput, error)
}

GetWakeUpTimeQueryHandle provides a handle for a example.updatabletimer.v1.Example.GetWakeUpTime query activity

func GetWakeUpTimeAsync 

func GetWakeUpTimeAsync(ctx workflow.Context, workflowID string, runID string, opts ...*GetWakeUpTimeQueryOptions) (GetWakeUpTimeQueryHandle, error)

GetWakeUpTimeAsync executes a(n) example.updatabletimer.v1.Example.GetWakeUpTime query and returns a handle to the activity

type GetWakeUpTimeQueryOptions 

type GetWakeUpTimeQueryOptions struct {
	ActivityOptions   *workflow.ActivityOptions
	HeartbeatInterval time.Duration
}

GetWakeUpTimeQueryOptions are used to configure a(n) example.updatabletimer.v1.Example.GetWakeUpTime query execution

func NewGetWakeUpTimeQueryOptions 

func NewGetWakeUpTimeQueryOptions() *GetWakeUpTimeQueryOptions

NewGetWakeUpTimeQueryOptions initializes a new GetWakeUpTimeQueryOptions value

func (*GetWakeUpTimeQueryOptions) WithActivityOptions 

func (opts *GetWakeUpTimeQueryOptions) WithActivityOptions(ao workflow.ActivityOptions) *GetWakeUpTimeQueryOptions

WithActivityOptions can be used to customize the activity options

func (*GetWakeUpTimeQueryOptions) WithHeartbeatInterval 

func (opts *GetWakeUpTimeQueryOptions) WithHeartbeatInterval(d time.Duration) *GetWakeUpTimeQueryOptions

WithHeartbeatInterval can be used to customize the activity heartbeat interval

type UpdatableTimerRun 

type UpdatableTimerRun interface {
	// Cancel cancels the workflow
	Cancel(workflow.Context) error

	// Future returns the inner workflow.Future
	Future() workflow.Future

	// Get returns the inner workflow.Future
	Get(workflow.Context) error

	// ID returns the workflow id
	ID() string

	// GetWakeUpTime retrieves the current timer expiration timestamp
	GetWakeUpTime(workflow.Context, ...*GetWakeUpTimeQueryOptions) (*v1.GetWakeUpTimeOutput, error)

	// GetWakeUpTime retrieves the current timer expiration timestamp
	GetWakeUpTimeAsync(workflow.Context, ...*GetWakeUpTimeQueryOptions) (GetWakeUpTimeQueryHandle, error)

	// UpdateWakeUpTime updates the timer expiration timestamp
	UpdateWakeUpTime(workflow.Context, *v1.UpdateWakeUpTimeInput, ...*UpdateWakeUpTimeSignalOptions) error

	// UpdateWakeUpTime updates the timer expiration timestamp
	UpdateWakeUpTimeAsync(workflow.Context, *v1.UpdateWakeUpTimeInput, ...*UpdateWakeUpTimeSignalOptions) (UpdateWakeUpTimeSignalHandle, error)
}

UpdatableTimerRun provides a handle to a UpdatableTimer workflow execution

func UpdatableTimerAsync 

func UpdatableTimerAsync(ctx workflow.Context, req *v1.UpdatableTimerInput, opts ...*UpdatableTimerWorkflowOptions) (UpdatableTimerRun, error)

UpdatableTimer describes an updatable timer workflow

type UpdatableTimerWorkflowOptions 

type UpdatableTimerWorkflowOptions struct {
	ActivityOptions      *workflow.ActivityOptions
	Detached             bool
	HeartbeatInterval    time.Duration
	ParentClosePolicy    enumsv1.ParentClosePolicy
	StartWorkflowOptions *client.StartWorkflowOptions
}

UpdatableTimerWorkflowOptions are used to configure a(n) UpdatableTimer workflow execution

func NewUpdatableTimerWorkflowOptions 

func NewUpdatableTimerWorkflowOptions() *UpdatableTimerWorkflowOptions

NewUpdatableTimerWorkflowOptions initializes a new UpdatableTimerWorkflowOptions value

func (*UpdatableTimerWorkflowOptions) WithActivityOptions 

func (opts *UpdatableTimerWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *UpdatableTimerWorkflowOptions

WithActivityOptions can be used to customize the activity options

func (*UpdatableTimerWorkflowOptions) WithDetached 

func (opts *UpdatableTimerWorkflowOptions) WithDetached(d bool) *UpdatableTimerWorkflowOptions

WithDetached can be used to start a workflow execution and exit immediately

func (*UpdatableTimerWorkflowOptions) WithHeartbeatInterval 

func (opts *UpdatableTimerWorkflowOptions) WithHeartbeatInterval(d time.Duration) *UpdatableTimerWorkflowOptions

WithHeartbeatInterval can be used to customize the activity heartbeat interval

func (*UpdatableTimerWorkflowOptions) WithParentClosePolicy added in v1.13.1 

func (opts *UpdatableTimerWorkflowOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *UpdatableTimerWorkflowOptions

WithParentClosePolicy can be used to customize the cancellation propagation behavior

func (*UpdatableTimerWorkflowOptions) WithStartWorkflow 

func (opts *UpdatableTimerWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *UpdatableTimerWorkflowOptions

WithStartWorkflowOptions can be used to customize the start workflow options

type UpdateWakeUpTimeSignalHandle 

type UpdateWakeUpTimeSignalHandle interface {
	// Cancel cancels the workflow
	Cancel(workflow.Context) error
	// Future returns the inner workflow.Future
	Future() workflow.Future
	// Get returns the inner workflow.Future
	Get(workflow.Context) error
}

UpdateWakeUpTimeSignalHandle provides a handle for a example.updatabletimer.v1.Example.UpdateWakeUpTime signal activity

func UpdateWakeUpTimeAsync 

func UpdateWakeUpTimeAsync(ctx workflow.Context, workflowID string, runID string, req *v1.UpdateWakeUpTimeInput, opts ...*UpdateWakeUpTimeSignalOptions) (UpdateWakeUpTimeSignalHandle, error)

UpdateWakeUpTimeAsync executes a(n) example.updatabletimer.v1.Example.UpdateWakeUpTime signal

type UpdateWakeUpTimeSignalOptions 

type UpdateWakeUpTimeSignalOptions struct {
	ActivityOptions   *workflow.ActivityOptions
	HeartbeatInterval time.Duration
}

UpdateWakeUpTimeSignalOptions are used to configure a(n) example.updatabletimer.v1.Example.UpdateWakeUpTime signal execution

func NewUpdateWakeUpTimeSignalOptions 

func NewUpdateWakeUpTimeSignalOptions() *UpdateWakeUpTimeSignalOptions

NewUpdateWakeUpTimeSignalOptions initializes a new UpdateWakeUpTimeSignalOptions value

func (*UpdateWakeUpTimeSignalOptions) WithActivityOptions 

func (opts *UpdateWakeUpTimeSignalOptions) WithActivityOptions(ao workflow.ActivityOptions) *UpdateWakeUpTimeSignalOptions

WithActivityOptions can be used to customize the activity options

func (*UpdateWakeUpTimeSignalOptions) WithHeartbeatInterval 

func (opts *UpdateWakeUpTimeSignalOptions) WithHeartbeatInterval(d time.Duration) *UpdateWakeUpTimeSignalOptions

WithHeartbeatInterval can be used to customize the activity heartbeat interval

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.