Documentation ¶
Overview ¶
Code generated by protoc-gen-go_temporal. DO NOT EDIT. versions:
protoc-gen-go_temporal 1.11.1-next (c39ba7f5af358428c18ecce12978be63d88f77f4) go go1.22.1 protoc (unknown)
source: example/xns/v1/xns.proto
Index ¶
- func CancelExampleWorkflow(ctx workflow.Context, workflowID string, runID string) error
- func CancelExampleWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
- func CancelXnsWorkflow(ctx workflow.Context, workflowID string, runID string) error
- func CancelXnsWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
- func CreateFoo(ctx workflow.Context, req *v1.CreateFooRequest, ...) (*v1.CreateFooResponse, error)
- func CreateFooWithSetFooProgress(ctx workflow.Context, req *v1.CreateFooRequest, ...) (*v1.CreateFooResponse, error)
- func GetFooProgress(ctx workflow.Context, workflowID string, runID string, ...) (*v1.GetFooProgressResponse, error)
- func ProvisionFoo(ctx workflow.Context, req *v1.ProvisionFooRequest, ...) (*v1.ProvisionFooResponse, error)
- func RegisterExampleActivities(r worker.ActivityRegistry, c v1.ExampleClient, options ...*ExampleOptions)
- func RegisterXnsActivities(r worker.ActivityRegistry, c v1.XnsClient, options ...*XnsOptions)
- func SetFooProgress(ctx workflow.Context, workflowID string, runID string, ...) error
- func UpdateFooProgress(ctx workflow.Context, workflowID string, runID string, ...) (*v1.GetFooProgressResponse, error)
- type CreateFooRun
- type CreateFooWorkflowOptions
- func (opts *CreateFooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *CreateFooWorkflowOptions
- func (opts *CreateFooWorkflowOptions) WithDetached(d bool) *CreateFooWorkflowOptions
- func (opts *CreateFooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *CreateFooWorkflowOptions
- func (opts *CreateFooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *CreateFooWorkflowOptions
- type ExampleOptions
- type GetFooProgressQueryHandle
- type GetFooProgressQueryOptions
- type ProvisionFooRun
- type ProvisionFooWorkflowOptions
- func (opts *ProvisionFooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *ProvisionFooWorkflowOptions
- func (opts *ProvisionFooWorkflowOptions) WithDetached(d bool) *ProvisionFooWorkflowOptions
- func (opts *ProvisionFooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *ProvisionFooWorkflowOptions
- func (opts *ProvisionFooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *ProvisionFooWorkflowOptions
- type SetFooProgressSignalHandle
- type SetFooProgressSignalOptions
- type UpdateFooProgressHandle
- type UpdateFooProgressUpdateOptions
- func (opts *UpdateFooProgressUpdateOptions) WithActivityOptions(ao workflow.ActivityOptions) *UpdateFooProgressUpdateOptions
- func (opts *UpdateFooProgressUpdateOptions) WithHeartbeatInterval(d time.Duration) *UpdateFooProgressUpdateOptions
- func (opts *UpdateFooProgressUpdateOptions) WithUpdateWorkflowOptions(uwo client.UpdateWorkflowWithOptionsRequest) *UpdateFooProgressUpdateOptions
- type XnsOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CancelExampleWorkflow ¶
CancelExampleWorkflow cancels an existing workflow
func CancelExampleWorkflowAsync ¶
func CancelExampleWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
CancelExampleWorkflowAsync cancels an existing workflow
func CancelXnsWorkflow ¶
CancelXnsWorkflow cancels an existing workflow
func CancelXnsWorkflowAsync ¶
CancelXnsWorkflowAsync cancels an existing workflow
func CreateFoo ¶
func CreateFoo(ctx workflow.Context, req *v1.CreateFooRequest, opts ...*CreateFooWorkflowOptions) (*v1.CreateFooResponse, error)
CreateFoo creates a new foo operation
func CreateFooWithSetFooProgress ¶
func CreateFooWithSetFooProgress(ctx workflow.Context, req *v1.CreateFooRequest, signal *v1.SetFooProgressRequest, opts ...*CreateFooWorkflowOptions) (*v1.CreateFooResponse, error)
CreateFooWithSetFooProgress sends a(n) example.xns.v1.Example.SetFooProgress signal to a example.xns.v1.Example.CreateFoo workflow, starting it if necessary, and blocks until the workflow completes
func GetFooProgress ¶
func GetFooProgress(ctx workflow.Context, workflowID string, runID string, opts ...*GetFooProgressQueryOptions) (*v1.GetFooProgressResponse, error)
GetFooProgress returns the status of a CreateFoo operation
func ProvisionFoo ¶
func ProvisionFoo(ctx workflow.Context, req *v1.ProvisionFooRequest, opts ...*ProvisionFooWorkflowOptions) (*v1.ProvisionFooResponse, error)
ProvisionFoo executes a(n) example.xns.v1.Xns.ProvisionFoo workflow and blocks until error or response received
func RegisterExampleActivities ¶
func RegisterExampleActivities(r worker.ActivityRegistry, c v1.ExampleClient, options ...*ExampleOptions)
RegisterExampleActivities registers example.xns.v1.Example cross-namespace activities
func RegisterXnsActivities ¶
func RegisterXnsActivities(r worker.ActivityRegistry, c v1.XnsClient, options ...*XnsOptions)
RegisterXnsActivities registers example.xns.v1.Xns cross-namespace activities
func SetFooProgress ¶
func SetFooProgress(ctx workflow.Context, workflowID string, runID string, req *v1.SetFooProgressRequest, opts ...*SetFooProgressSignalOptions) error
SetFooProgress sets the current status of a CreateFoo operation
func UpdateFooProgress ¶
func UpdateFooProgress(ctx workflow.Context, workflowID string, runID string, req *v1.SetFooProgressRequest, opts ...*UpdateFooProgressUpdateOptions) (*v1.GetFooProgressResponse, error)
UpdateFooProgress sets the current status of a CreateFoo operation
Types ¶
type CreateFooRun ¶
type CreateFooRun 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.CreateFooResponse, error) // ID returns the workflow id ID() string // GetFooProgress returns the status of a CreateFoo operation GetFooProgress(workflow.Context, ...*GetFooProgressQueryOptions) (*v1.GetFooProgressResponse, error) // GetFooProgress returns the status of a CreateFoo operation GetFooProgressAsync(workflow.Context, ...*GetFooProgressQueryOptions) (GetFooProgressQueryHandle, error) // SetFooProgress sets the current status of a CreateFoo operation SetFooProgress(workflow.Context, *v1.SetFooProgressRequest, ...*SetFooProgressSignalOptions) error // SetFooProgress sets the current status of a CreateFoo operation SetFooProgressAsync(workflow.Context, *v1.SetFooProgressRequest, ...*SetFooProgressSignalOptions) (SetFooProgressSignalHandle, error) // UpdateFooProgress sets the current status of a CreateFoo operation UpdateFooProgress(workflow.Context, *v1.SetFooProgressRequest, ...*UpdateFooProgressUpdateOptions) (*v1.GetFooProgressResponse, error) // UpdateFooProgress sets the current status of a CreateFoo operation UpdateFooProgressAsync(workflow.Context, *v1.SetFooProgressRequest, ...*UpdateFooProgressUpdateOptions) (UpdateFooProgressHandle, error) }
CreateFooRun provides a handle to a example.xns.v1.Example.CreateFoo workflow execution
func CreateFooAsync ¶
func CreateFooAsync(ctx workflow.Context, req *v1.CreateFooRequest, opts ...*CreateFooWorkflowOptions) (CreateFooRun, error)
CreateFoo creates a new foo operation
func CreateFooWithSetFooProgressAsync ¶
func CreateFooWithSetFooProgressAsync(ctx workflow.Context, req *v1.CreateFooRequest, signal *v1.SetFooProgressRequest, opts ...*CreateFooWorkflowOptions) (CreateFooRun, error)
CreateFooWithSetFooProgressAsync sends a(n) example.xns.v1.Example.SetFooProgress signal to a(n) example.xns.v1.Example.CreateFoo workflow, starting it if necessary, and returns a handle to the underlying activity
type CreateFooWorkflowOptions ¶
type CreateFooWorkflowOptions struct { ActivityOptions *workflow.ActivityOptions Detached bool HeartbeatInterval time.Duration StartWorkflowOptions *client.StartWorkflowOptions }
CreateFooWorkflowOptions are used to configure a(n) example.xns.v1.Example.CreateFoo workflow execution
func NewCreateFooWorkflowOptions ¶
func NewCreateFooWorkflowOptions() *CreateFooWorkflowOptions
NewCreateFooWorkflowOptions initializes a new CreateFooWorkflowOptions value
func (*CreateFooWorkflowOptions) WithActivityOptions ¶
func (opts *CreateFooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *CreateFooWorkflowOptions
WithActivityOptions can be used to customize the activity options
func (*CreateFooWorkflowOptions) WithDetached ¶
func (opts *CreateFooWorkflowOptions) WithDetached(d bool) *CreateFooWorkflowOptions
WithDetached can be used to start a workflow execution and exit immediately
func (*CreateFooWorkflowOptions) WithHeartbeatInterval ¶
func (opts *CreateFooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *CreateFooWorkflowOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
func (*CreateFooWorkflowOptions) WithStartWorkflow ¶
func (opts *CreateFooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *CreateFooWorkflowOptions
WithStartWorkflowOptions can be used to customize the start workflow options
type ExampleOptions ¶
type ExampleOptions struct {
// contains filtered or unexported fields
}
ExampleOptions is used to configure example.xns.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 GetFooProgressQueryHandle ¶
type GetFooProgressQueryHandle 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.GetFooProgressResponse, error) }
GetFooProgressQueryHandle provides a handle for a example.xns.v1.Example.GetFooProgress query activity
func GetFooProgressAsync ¶
func GetFooProgressAsync(ctx workflow.Context, workflowID string, runID string, opts ...*GetFooProgressQueryOptions) (GetFooProgressQueryHandle, error)
GetFooProgressAsync executes a(n) example.xns.v1.Example.GetFooProgress query and returns a handle to the activity
type GetFooProgressQueryOptions ¶
type GetFooProgressQueryOptions struct { ActivityOptions *workflow.ActivityOptions HeartbeatInterval time.Duration }
GetFooProgressQueryOptions are used to configure a(n) example.xns.v1.Example.GetFooProgress query execution
func NewGetFooProgressQueryOptions ¶
func NewGetFooProgressQueryOptions() *GetFooProgressQueryOptions
NewGetFooProgressQueryOptions initializes a new GetFooProgressQueryOptions value
func (*GetFooProgressQueryOptions) WithActivityOptions ¶
func (opts *GetFooProgressQueryOptions) WithActivityOptions(ao workflow.ActivityOptions) *GetFooProgressQueryOptions
WithActivityOptions can be used to customize the activity options
func (*GetFooProgressQueryOptions) WithHeartbeatInterval ¶
func (opts *GetFooProgressQueryOptions) WithHeartbeatInterval(d time.Duration) *GetFooProgressQueryOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
type ProvisionFooRun ¶
type ProvisionFooRun 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.ProvisionFooResponse, error) // ID returns the workflow id ID() string }
ProvisionFooRun provides a handle to a example.xns.v1.Xns.ProvisionFoo workflow execution
func ProvisionFooAsync ¶
func ProvisionFooAsync(ctx workflow.Context, req *v1.ProvisionFooRequest, opts ...*ProvisionFooWorkflowOptions) (ProvisionFooRun, error)
ProvisionFooAsync executes a(n) example.xns.v1.Xns.ProvisionFoo workflow and blocks until error or response received
type ProvisionFooWorkflowOptions ¶
type ProvisionFooWorkflowOptions struct { ActivityOptions *workflow.ActivityOptions Detached bool HeartbeatInterval time.Duration StartWorkflowOptions *client.StartWorkflowOptions }
ProvisionFooWorkflowOptions are used to configure a(n) example.xns.v1.Xns.ProvisionFoo workflow execution
func NewProvisionFooWorkflowOptions ¶
func NewProvisionFooWorkflowOptions() *ProvisionFooWorkflowOptions
NewProvisionFooWorkflowOptions initializes a new ProvisionFooWorkflowOptions value
func (*ProvisionFooWorkflowOptions) WithActivityOptions ¶
func (opts *ProvisionFooWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *ProvisionFooWorkflowOptions
WithActivityOptions can be used to customize the activity options
func (*ProvisionFooWorkflowOptions) WithDetached ¶
func (opts *ProvisionFooWorkflowOptions) WithDetached(d bool) *ProvisionFooWorkflowOptions
WithDetached can be used to start a workflow execution and exit immediately
func (*ProvisionFooWorkflowOptions) WithHeartbeatInterval ¶
func (opts *ProvisionFooWorkflowOptions) WithHeartbeatInterval(d time.Duration) *ProvisionFooWorkflowOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
func (*ProvisionFooWorkflowOptions) WithStartWorkflow ¶
func (opts *ProvisionFooWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *ProvisionFooWorkflowOptions
WithStartWorkflowOptions can be used to customize the start workflow options
type SetFooProgressSignalHandle ¶
type SetFooProgressSignalHandle 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 }
SetFooProgressSignalHandle provides a handle for a example.xns.v1.Example.SetFooProgress signal activity
func SetFooProgressAsync ¶
func SetFooProgressAsync(ctx workflow.Context, workflowID string, runID string, req *v1.SetFooProgressRequest, opts ...*SetFooProgressSignalOptions) (SetFooProgressSignalHandle, error)
SetFooProgressAsync executes a(n) example.xns.v1.Example.SetFooProgress signal
type SetFooProgressSignalOptions ¶
type SetFooProgressSignalOptions struct { ActivityOptions *workflow.ActivityOptions HeartbeatInterval time.Duration }
SetFooProgressSignalOptions are used to configure a(n) example.xns.v1.Example.SetFooProgress signal execution
func NewSetFooProgressSignalOptions ¶
func NewSetFooProgressSignalOptions() *SetFooProgressSignalOptions
NewSetFooProgressSignalOptions initializes a new SetFooProgressSignalOptions value
func (*SetFooProgressSignalOptions) WithActivityOptions ¶
func (opts *SetFooProgressSignalOptions) WithActivityOptions(ao workflow.ActivityOptions) *SetFooProgressSignalOptions
WithActivityOptions can be used to customize the activity options
func (*SetFooProgressSignalOptions) WithHeartbeatInterval ¶
func (opts *SetFooProgressSignalOptions) WithHeartbeatInterval(d time.Duration) *SetFooProgressSignalOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
type UpdateFooProgressHandle ¶
type UpdateFooProgressHandle interface { // Cancel cancels the update activity Cancel(workflow.Context) error // Future returns the inner workflow.Future Future() workflow.Future // Get blocks on update completion and returns the result Get(workflow.Context) (*v1.GetFooProgressResponse, error) // ID returns the update id ID() string }
UpdateFooProgressHandle provides a handle to a example.xns.v1.Example.UpdateFooProgress workflow update
func UpdateFooProgressAsync ¶
func UpdateFooProgressAsync(ctx workflow.Context, workflowID string, runID string, req *v1.SetFooProgressRequest, opts ...*UpdateFooProgressUpdateOptions) (UpdateFooProgressHandle, error)
UpdateFooProgressAsync executes a(n) example.xns.v1.Example.UpdateFooProgress update and blocks until error or response received
type UpdateFooProgressUpdateOptions ¶
type UpdateFooProgressUpdateOptions struct { ActivityOptions *workflow.ActivityOptions HeartbeatInterval time.Duration UpdateWorkflowOptions *client.UpdateWorkflowWithOptionsRequest }
UpdateFooProgressUpdateOptions are used to configure a(n) example.xns.v1.Example.UpdateFooProgress update execution
func NewUpdateFooProgressUpdateOptions ¶
func NewUpdateFooProgressUpdateOptions() *UpdateFooProgressUpdateOptions
NewUpdateFooProgressUpdateOptions initializes a new UpdateFooProgressUpdateOptions value
func (*UpdateFooProgressUpdateOptions) WithActivityOptions ¶
func (opts *UpdateFooProgressUpdateOptions) WithActivityOptions(ao workflow.ActivityOptions) *UpdateFooProgressUpdateOptions
WithActivityOptions can be used to customize the activity options
func (*UpdateFooProgressUpdateOptions) WithHeartbeatInterval ¶
func (opts *UpdateFooProgressUpdateOptions) WithHeartbeatInterval(d time.Duration) *UpdateFooProgressUpdateOptions
WithHeartbeatInterval can be used to customize the activity heartbeat interval
func (*UpdateFooProgressUpdateOptions) WithUpdateWorkflowOptions ¶
func (opts *UpdateFooProgressUpdateOptions) WithUpdateWorkflowOptions(uwo client.UpdateWorkflowWithOptionsRequest) *UpdateFooProgressUpdateOptions
WithUpdateWorkflowOptions can be used to customize the update workflow options
type XnsOptions ¶
type XnsOptions struct {
// contains filtered or unexported fields
}
XnsOptions is used to configure example.xns.v1.Xns xns activity registration
func NewXnsOptions ¶ added in v1.10.4
func NewXnsOptions() *XnsOptions
NewXnsOptions initializes a new XnsOptions value
func (*XnsOptions) WithErrorConverter ¶ added in v1.10.4
func (opts *XnsOptions) WithErrorConverter(errorConverter func(error) error) *XnsOptions
WithErrorConverter overrides the default error converter applied to xns activity errors
func (*XnsOptions) WithFilter ¶ added in v1.10.4
func (opts *XnsOptions) WithFilter(filter func(string) string) *XnsOptions
Filter is used to filter registered xns activities or customize their name