Documentation
¶
Overview ¶
Code generated by protoc-gen-go_temporal. DO NOT EDIT. versions:
protoc-gen-go_temporal dev (latest) protoc (unknown)
source: test/patch/example.proto
Index ¶
- func CancelFooServiceWorkflow(ctx workflow.Context, workflowID string, runID string) error
- func CancelFooServiceWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
- func Foo(ctx workflow.Context, req *patch.FooInput, opts ...*FooWorkflowOptions) (*patch.FooOutput, error)
- func GetFoo(ctx workflow.Context, workflowID string, runID string, ...) (out *patch.FooOutput, err error)
- func RegisterFooServiceActivities(r worker.ActivityRegistry, c patch.FooServiceClient, ...)
- type FooRun
- type FooServiceOptions
- type FooWorkflowOptions
- func (opts *FooWorkflowOptions) Build(ctx workflow.Context, input *patch.FooInput) (workflow.Context, *xnsv1.WorkflowRequest, error)
- func (opts *FooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *FooWorkflowOptions
- func (opts *FooWorkflowOptions) WithDetached(d bool) *FooWorkflowOptions
- func (opts *FooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *FooWorkflowOptions
- func (opts *FooWorkflowOptions) WithHeartbeatTimeout(d time.Duration) *FooWorkflowOptions
- func (opts *FooWorkflowOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *FooWorkflowOptions
- func (opts *FooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *FooWorkflowOptions
- type GetFooOptions
- func (opt *GetFooOptions) Build(ctx workflow.Context, workflowID string, runID string) (workflow.Context, *xnsv1.GetWorkflowRequest, error)
- func (o *GetFooOptions) WithActivityOptions(ao workflow.ActivityOptions) *GetFooOptions
- func (o *GetFooOptions) WithHeartbeatInterval(d time.Duration) *GetFooOptions
- func (o *GetFooOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *GetFooOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CancelFooServiceWorkflow ¶
CancelFooServiceWorkflow cancels an existing workflow
func CancelFooServiceWorkflowAsync ¶
func CancelFooServiceWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
CancelFooServiceWorkflowAsync cancels an existing workflow
func Foo ¶
func Foo(ctx workflow.Context, req *patch.FooInput, opts ...*FooWorkflowOptions) (*patch.FooOutput, error)
Foo executes a(n) test.patch.FooService.Foo workflow and blocks until error or response is received
func GetFoo ¶ added in v1.17.0
func GetFoo(ctx workflow.Context, workflowID string, runID string, options ...*GetFooOptions) (out *patch.FooOutput, err error)
GetFoo returns a(n) test.patch.FooService.Foo workflow execution
func RegisterFooServiceActivities ¶
func RegisterFooServiceActivities(r worker.ActivityRegistry, c patch.FooServiceClient, options ...*FooServiceOptions)
RegisterFooServiceActivities registers test.patch.FooService cross-namespace activities
Types ¶
type FooRun ¶
type FooRun 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) (*patch.FooOutput, error)
// ID returns the workflow id
ID() string
}
FooRun provides a handle to a test.patch.FooService.Foo workflow execution
func FooAsync ¶
func FooAsync(ctx workflow.Context, input *patch.FooInput, opts ...*FooWorkflowOptions) (FooRun, error)
FooAsync executes a(n) test.patch.FooService.Foo workflow and returns a handle to the underlying activity
func GetFooAsync ¶ added in v1.17.0
func GetFooAsync(ctx workflow.Context, workflowID string, runID string, options ...*GetFooOptions) FooRun
GetFooAsync returns a handle to a(n) test.patch.FooService.Foo workflow execution
type FooServiceOptions ¶
type FooServiceOptions struct {
// contains filtered or unexported fields
}
FooServiceOptions is used to configure test.patch.FooService xns activity registration
func NewFooServiceOptions ¶
func NewFooServiceOptions() *FooServiceOptions
NewFooServiceOptions initializes a new FooServiceOptions value
func (*FooServiceOptions) WithErrorConverter ¶
func (opts *FooServiceOptions) WithErrorConverter(errorConverter func(error) error) *FooServiceOptions
WithErrorConverter overrides the default error converter applied to xns activity errors
func (*FooServiceOptions) WithFilter ¶
func (opts *FooServiceOptions) WithFilter(filter func(string) string) *FooServiceOptions
Filter is used to filter registered xns activities or customize their name
type FooWorkflowOptions ¶
type FooWorkflowOptions struct {
ActivityOptions *workflow.ActivityOptions
Detached bool
HeartbeatInterval time.Duration
HeartbeatTimeout time.Duration
ParentClosePolicy enumsv1.ParentClosePolicy
StartWorkflowOptions *client.StartWorkflowOptions
}
FooWorkflowOptions are used to configure a(n) test.patch.FooService.Foo workflow execution
func NewFooWorkflowOptions ¶
func NewFooWorkflowOptions() *FooWorkflowOptions
NewFooWorkflowOptions initializes a new FooWorkflowOptions value
func (*FooWorkflowOptions) Build ¶ added in v1.17.0
func (opts *FooWorkflowOptions) Build(ctx workflow.Context, input *patch.FooInput) (workflow.Context, *xnsv1.WorkflowRequest, error)
Build initializes the activity context and input
func (*FooWorkflowOptions) WithActivityOptions ¶
func (opts *FooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *FooWorkflowOptions
WithActivityOptions can be used to customize the activity options
func (*FooWorkflowOptions) WithDetached ¶
func (opts *FooWorkflowOptions) WithDetached(d bool) *FooWorkflowOptions
WithDetached can be used to start a workflow execution and exit immediately
func (*FooWorkflowOptions) WithHeartbeatInterval ¶
func (opts *FooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *FooWorkflowOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
func (*FooWorkflowOptions) WithHeartbeatTimeout ¶ added in v1.17.0
func (opts *FooWorkflowOptions) WithHeartbeatTimeout(d time.Duration) *FooWorkflowOptions
WithHeartbeatTimeout can be used to customize the activity heartbeat timeout
func (*FooWorkflowOptions) WithParentClosePolicy ¶
func (opts *FooWorkflowOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *FooWorkflowOptions
WithParentClosePolicy can be used to customize the cancellation propagation behavior
func (*FooWorkflowOptions) WithStartWorkflow ¶
func (opts *FooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *FooWorkflowOptions
WithStartWorkflowOptions can be used to customize the start workflow options
type GetFooOptions ¶ added in v1.17.0
type GetFooOptions struct {
// contains filtered or unexported fields
}
GetFooOptions are used to configure a(n) test.patch.FooService.Foo workflow execution getter activity
func NewGetFooOptions ¶ added in v1.17.0
func NewGetFooOptions() *GetFooOptions
NewGetFooOptions initializes a new GetFooOptions value
func (*GetFooOptions) Build ¶ added in v1.17.0
func (opt *GetFooOptions) Build(ctx workflow.Context, workflowID string, runID string) (workflow.Context, *xnsv1.GetWorkflowRequest, error)
Build initializes the activity context and input
func (*GetFooOptions) WithActivityOptions ¶ added in v1.17.0
func (o *GetFooOptions) WithActivityOptions(ao workflow.ActivityOptions) *GetFooOptions
WithActivityOptions can be used to customize the activity options
func (*GetFooOptions) WithHeartbeatInterval ¶ added in v1.17.0
func (o *GetFooOptions) WithHeartbeatInterval(d time.Duration) *GetFooOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
func (*GetFooOptions) WithParentClosePolicy ¶ added in v1.17.0
func (o *GetFooOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *GetFooOptions
WithParentClosePolicy can be used to customize the cancellation propagation behavior