Documentation
¶
Overview ¶
Code generated by protoc-gen-go_temporal. DO NOT EDIT. versions:
protoc-gen-go_temporal dev (latest) protoc (unknown)
source: fx/stdtemporalfx/internal/v1/work.proto
Index ¶
- Constants
- Variables
- func NewTestServiceClientOptions() *testServiceClientOptions
- func RegisterFooWorkflow(r worker.WorkflowRegistry, ...)
- func RegisterTestServiceActivities(r worker.ActivityRegistry, activities TestServiceActivities)
- func RegisterTestServiceWorkflows(r worker.WorkflowRegistry, workflows TestServiceWorkflows)
- type FooChildOptions
- func (o *FooChildOptions) Build(ctx workflow.Context, req protoreflect.Message) (workflow.ChildWorkflowOptions, error)
- func (o *FooChildOptions) WithChildWorkflowOptions(options workflow.ChildWorkflowOptions) *FooChildOptions
- func (o *FooChildOptions) WithDataConverter(dc converter.DataConverter) *FooChildOptions
- func (o *FooChildOptions) WithExecutionTimeout(d time.Duration) *FooChildOptions
- func (o *FooChildOptions) WithID(id string) *FooChildOptions
- func (o *FooChildOptions) WithIDReusePolicy(policy enumsv1.WorkflowIdReusePolicy) *FooChildOptions
- func (o *FooChildOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *FooChildOptions
- func (o *FooChildOptions) WithRetryPolicy(policy *temporal.RetryPolicy) *FooChildOptions
- func (o *FooChildOptions) WithRunTimeout(d time.Duration) *FooChildOptions
- func (o *FooChildOptions) WithSearchAttributes(sa map[string]any) *FooChildOptions
- func (o *FooChildOptions) WithTaskQueue(tq string) *FooChildOptions
- func (o *FooChildOptions) WithTaskTimeout(d time.Duration) *FooChildOptions
- func (o *FooChildOptions) WithWaitForCancellation(wait bool) *FooChildOptions
- func (o *FooChildOptions) WithWorkflowIdConflictPolicy(policy enumsv1.WorkflowIdConflictPolicy) *FooChildOptions
- type FooChildRun
- func (r *FooChildRun) Get(ctx workflow.Context) (*FooOutput, error)
- func (r *FooChildRun) Select(sel workflow.Selector, fn func(*FooChildRun)) workflow.Selector
- func (r *FooChildRun) SelectStart(sel workflow.Selector, fn func(*FooChildRun)) workflow.Selector
- func (r *FooChildRun) WaitStart(ctx workflow.Context) (*workflow.Execution, error)
- type FooInput
- type FooInput_builder
- type FooOptions
- func (o *FooOptions) Build(req protoreflect.Message) (client.StartWorkflowOptions, error)
- func (o *FooOptions) WithExecutionTimeout(d time.Duration) *FooOptions
- func (o *FooOptions) WithID(id string) *FooOptions
- func (o *FooOptions) WithIDReusePolicy(policy enumsv1.WorkflowIdReusePolicy) *FooOptions
- func (o *FooOptions) WithRetryPolicy(policy *temporal.RetryPolicy) *FooOptions
- func (o *FooOptions) WithRunTimeout(d time.Duration) *FooOptions
- func (o *FooOptions) WithSearchAttributes(sa map[string]any) *FooOptions
- func (o *FooOptions) WithStartWorkflowOptions(options client.StartWorkflowOptions) *FooOptions
- func (o *FooOptions) WithTaskQueue(tq string) *FooOptions
- func (o *FooOptions) WithTaskTimeout(d time.Duration) *FooOptions
- func (o *FooOptions) WithWorkflowIdConflictPolicy(policy enumsv1.WorkflowIdConflictPolicy) *FooOptions
- type FooOutput
- type FooOutput_builder
- type FooRun
- type FooWorkflow
- type FooWorkflowInput
- type TestServiceActivities
- type TestServiceClient
- type TestServiceWorkflowFunctions
- type TestServiceWorkflows
- type TestTestServiceClient
- func (c *TestTestServiceClient) CancelWorkflow(ctx context.Context, workflowID string, runID string) error
- func (c *TestTestServiceClient) Foo(ctx context.Context, req *FooInput, opts ...*FooOptions) (*FooOutput, error)
- func (c *TestTestServiceClient) FooAsync(ctx context.Context, req *FooInput, options ...*FooOptions) (FooRun, error)
- func (c *TestTestServiceClient) GetFoo(ctx context.Context, workflowID string, runID string) FooRun
- func (c *TestTestServiceClient) TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, ...) error
Constants ¶
const (
FooWorkflowName = "fx.stdtemporalfx.internal.v1.TestService.Foo"
)
fx.stdtemporalfx.internal.v1.TestService workflow names
Variables ¶
var File_fx_stdtemporalfx_internal_v1_work_proto protoreflect.FileDescriptor
var ( // FooFunction implements a "fx.stdtemporalfx.internal.v1.TestService.Foo" workflow FooFunction func(workflow.Context, *FooInput) (*FooOutput, error) )
Reference to generated workflow functions
var TestServiceTaskQueue = "test-v1"
TestServiceTaskQueue is the default task-queue for a fx.stdtemporalfx.internal.v1.TestService worker
Functions ¶
func NewTestServiceClientOptions ¶
func NewTestServiceClientOptions() *testServiceClientOptions
NewTestServiceClientOptions initializes a new testServiceClientOptions value
func RegisterFooWorkflow ¶
func RegisterFooWorkflow(r worker.WorkflowRegistry, wf func(workflow.Context, *FooWorkflowInput) (FooWorkflow, error))
RegisterFooWorkflow registers a fx.stdtemporalfx.internal.v1.TestService.Foo workflow with the given worker
func RegisterTestServiceActivities ¶
func RegisterTestServiceActivities(r worker.ActivityRegistry, activities TestServiceActivities)
RegisterTestServiceActivities registers activities with a worker
func RegisterTestServiceWorkflows ¶
func RegisterTestServiceWorkflows(r worker.WorkflowRegistry, workflows TestServiceWorkflows)
RegisterTestServiceWorkflows registers fx.stdtemporalfx.internal.v1.TestService workflows with the given worker
Types ¶
type FooChildOptions ¶
type FooChildOptions struct {
// contains filtered or unexported fields
}
FooChildOptions provides configuration for a child fx.stdtemporalfx.internal.v1.TestService.Foo workflow operation
func NewFooChildOptions ¶
func NewFooChildOptions() *FooChildOptions
NewFooChildOptions initializes a new FooChildOptions value
func (*FooChildOptions) Build ¶
func (o *FooChildOptions) Build(ctx workflow.Context, req protoreflect.Message) (workflow.ChildWorkflowOptions, error)
Build initializes a new go.temporal.io/sdk/workflow.ChildWorkflowOptions value with defaults and overrides applied
func (*FooChildOptions) WithChildWorkflowOptions ¶
func (o *FooChildOptions) WithChildWorkflowOptions(options workflow.ChildWorkflowOptions) *FooChildOptions
WithChildWorkflowOptions sets the initial go.temporal.io/sdk/workflow.ChildWorkflowOptions
func (*FooChildOptions) WithDataConverter ¶
func (o *FooChildOptions) WithDataConverter(dc converter.DataConverter) *FooChildOptions
WithDataConverter registers a DataConverter for the child workflow
func (*FooChildOptions) WithExecutionTimeout ¶
func (o *FooChildOptions) WithExecutionTimeout(d time.Duration) *FooChildOptions
WithExecutionTimeout sets the WorkflowExecutionTimeout value
func (*FooChildOptions) WithID ¶
func (o *FooChildOptions) WithID(id string) *FooChildOptions
WithID sets the WorkflowID value
func (*FooChildOptions) WithIDReusePolicy ¶
func (o *FooChildOptions) WithIDReusePolicy(policy enumsv1.WorkflowIdReusePolicy) *FooChildOptions
WithIDReusePolicy sets the WorkflowIDReusePolicy value
func (*FooChildOptions) WithParentClosePolicy ¶
func (o *FooChildOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *FooChildOptions
WithParentClosePolicy sets the WorkflowIDReusePolicy value
func (*FooChildOptions) WithRetryPolicy ¶
func (o *FooChildOptions) WithRetryPolicy(policy *temporal.RetryPolicy) *FooChildOptions
WithRetryPolicy sets the RetryPolicy value
func (*FooChildOptions) WithRunTimeout ¶
func (o *FooChildOptions) WithRunTimeout(d time.Duration) *FooChildOptions
WithRunTimeout sets the WorkflowRunTimeout value
func (*FooChildOptions) WithSearchAttributes ¶
func (o *FooChildOptions) WithSearchAttributes(sa map[string]any) *FooChildOptions
WithSearchAttributes sets the SearchAttributes value
func (*FooChildOptions) WithTaskQueue ¶
func (o *FooChildOptions) WithTaskQueue(tq string) *FooChildOptions
WithTaskQueue sets the TaskQueue value
func (*FooChildOptions) WithTaskTimeout ¶
func (o *FooChildOptions) WithTaskTimeout(d time.Duration) *FooChildOptions
WithTaskTimeout sets the WorkflowTaskTimeout value
func (*FooChildOptions) WithWaitForCancellation ¶
func (o *FooChildOptions) WithWaitForCancellation(wait bool) *FooChildOptions
WithWaitForCancellation sets the WaitForCancellation value
func (*FooChildOptions) WithWorkflowIdConflictPolicy ¶
func (o *FooChildOptions) WithWorkflowIdConflictPolicy(policy enumsv1.WorkflowIdConflictPolicy) *FooChildOptions
WithWorkflowIdConflictPolicy sets the WorkflowIdConflictPolicy value
type FooChildRun ¶
type FooChildRun struct {
Future workflow.ChildWorkflowFuture
}
FooChildRun describes a child Foo workflow run
func FooChildAsync ¶
func FooChildAsync(ctx workflow.Context, req *FooInput, options ...*FooChildOptions) (*FooChildRun, error)
FooChildAsync starts a child fx.stdtemporalfx.internal.v1.TestService.Foo workflow and returns a handle to the child workflow run
func (*FooChildRun) Get ¶
func (r *FooChildRun) Get(ctx workflow.Context) (*FooOutput, error)
Get blocks until the workflow is completed, returning the response value
func (*FooChildRun) Select ¶
func (r *FooChildRun) Select(sel workflow.Selector, fn func(*FooChildRun)) workflow.Selector
Select adds this completion to the selector. Callback can be nil.
func (*FooChildRun) SelectStart ¶
func (r *FooChildRun) SelectStart(sel workflow.Selector, fn func(*FooChildRun)) workflow.Selector
SelectStart adds waiting for start to the selector. Callback can be nil.
type FooInput ¶
type FooInput struct {
XXX_raceDetectHookData protoimpl.RaceDetectHookData
XXX_presence [1]uint32
// contains filtered or unexported fields
}
func (*FooInput) ProtoMessage ¶
func (*FooInput) ProtoMessage()
func (*FooInput) ProtoReflect ¶
func (x *FooInput) ProtoReflect() protoreflect.Message
type FooInput_builder ¶
type FooInput_builder struct {
Bar *string
// contains filtered or unexported fields
}
func (FooInput_builder) Build ¶
func (b0 FooInput_builder) Build() *FooInput
type FooOptions ¶
type FooOptions struct {
// contains filtered or unexported fields
}
FooOptions provides configuration for a fx.stdtemporalfx.internal.v1.TestService.Foo workflow operation
func NewFooOptions ¶
func NewFooOptions() *FooOptions
NewFooOptions initializes a new FooOptions value
func (*FooOptions) Build ¶
func (o *FooOptions) Build(req protoreflect.Message) (client.StartWorkflowOptions, error)
Build initializes a new go.temporal.io/sdk/client.StartWorkflowOptions value with defaults and overrides applied
func (*FooOptions) WithExecutionTimeout ¶
func (o *FooOptions) WithExecutionTimeout(d time.Duration) *FooOptions
WithExecutionTimeout sets the WorkflowExecutionTimeout value
func (*FooOptions) WithID ¶
func (o *FooOptions) WithID(id string) *FooOptions
WithID sets the ID value
func (*FooOptions) WithIDReusePolicy ¶
func (o *FooOptions) WithIDReusePolicy(policy enumsv1.WorkflowIdReusePolicy) *FooOptions
WithIDReusePolicy sets the WorkflowIDReusePolicy value
func (*FooOptions) WithRetryPolicy ¶
func (o *FooOptions) WithRetryPolicy(policy *temporal.RetryPolicy) *FooOptions
WithRetryPolicy sets the RetryPolicy value
func (*FooOptions) WithRunTimeout ¶
func (o *FooOptions) WithRunTimeout(d time.Duration) *FooOptions
WithRunTimeout sets the WorkflowRunTimeout value
func (*FooOptions) WithSearchAttributes ¶
func (o *FooOptions) WithSearchAttributes(sa map[string]any) *FooOptions
WithSearchAttributes sets the SearchAttributes value
func (*FooOptions) WithStartWorkflowOptions ¶
func (o *FooOptions) WithStartWorkflowOptions(options client.StartWorkflowOptions) *FooOptions
WithStartWorkflowOptions sets the initial go.temporal.io/sdk/client.StartWorkflowOptions
func (*FooOptions) WithTaskQueue ¶
func (o *FooOptions) WithTaskQueue(tq string) *FooOptions
WithTaskQueue sets the TaskQueue value
func (*FooOptions) WithTaskTimeout ¶
func (o *FooOptions) WithTaskTimeout(d time.Duration) *FooOptions
WithTaskTimeout sets the WorkflowTaskTimeout value
func (*FooOptions) WithWorkflowIdConflictPolicy ¶
func (o *FooOptions) WithWorkflowIdConflictPolicy(policy enumsv1.WorkflowIdConflictPolicy) *FooOptions
WithWorkflowIdConflictPolicy sets the WorkflowIdConflictPolicy value
type FooOutput ¶
type FooOutput struct {
// contains filtered or unexported fields
}
func FooChild ¶
FooChild executes a child fx.stdtemporalfx.internal.v1.TestService.Foo workflow and blocks until error or response received
func (*FooOutput) ProtoMessage ¶
func (*FooOutput) ProtoMessage()
func (*FooOutput) ProtoReflect ¶
func (x *FooOutput) ProtoReflect() protoreflect.Message
type FooOutput_builder ¶
type FooOutput_builder struct {
// contains filtered or unexported fields
}
func (FooOutput_builder) Build ¶
func (b0 FooOutput_builder) Build() *FooOutput
type FooRun ¶
type FooRun interface {
// ID returns the workflow ID
ID() string
// RunID returns the workflow instance ID
RunID() string
// Run returns the inner client.WorkflowRun
Run() client.WorkflowRun
// Get blocks until the workflow is complete and returns the result
Get(ctx context.Context) (*FooOutput, error)
// Cancel requests cancellation of a workflow in execution, returning an error if applicable
Cancel(ctx context.Context) error
// Terminate terminates a workflow in execution, returning an error if applicable
Terminate(ctx context.Context, reason string, details ...interface{}) error
}
FooRun describes a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow run
type FooWorkflow ¶
type FooWorkflow interface {
// Execute defines the entrypoint to a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow
Execute(ctx workflow.Context) (*FooOutput, error)
}
FooWorkflow describes a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow implementation
type FooWorkflowInput ¶
type FooWorkflowInput struct {
Req *FooInput
}
FooWorkflowInput describes the input to a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow constructor
type TestServiceActivities ¶
type TestServiceActivities interface{}
TestServiceActivities describes available worker activities
type TestServiceClient ¶
type TestServiceClient interface {
// Foo executes a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow and blocks until error or response received
Foo(ctx context.Context, req *FooInput, opts ...*FooOptions) (*FooOutput, error)
// FooAsync starts a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow and returns a handle to the workflow run
FooAsync(ctx context.Context, req *FooInput, opts ...*FooOptions) (FooRun, error)
// GetFoo retrieves a handle to an existing fx.stdtemporalfx.internal.v1.TestService.Foo workflow execution
GetFoo(ctx context.Context, workflowID string, runID string) FooRun
// CancelWorkflow requests cancellation of an existing workflow execution
CancelWorkflow(ctx context.Context, workflowID string, runID string) error
// TerminateWorkflow an existing workflow execution
TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details ...interface{}) error
}
TestServiceClient describes a client for a(n) fx.stdtemporalfx.internal.v1.TestService worker
func NewTestServiceClient ¶
func NewTestServiceClient(c client.Client, options ...*testServiceClientOptions) TestServiceClient
NewTestServiceClient initializes a new fx.stdtemporalfx.internal.v1.TestService client
func NewTestServiceClientWithOptions ¶
func NewTestServiceClientWithOptions(c client.Client, opts client.Options, options ...*testServiceClientOptions) (TestServiceClient, error)
NewTestServiceClientWithOptions initializes a new TestService client with the given options
type TestServiceWorkflowFunctions ¶
type TestServiceWorkflowFunctions interface {
// Foo executes a "fx.stdtemporalfx.internal.v1.TestService.Foo" workflow inline
Foo(workflow.Context, *FooInput) (*FooOutput, error)
}
TestServiceWorkflowFunctions describes a mockable dependency for inlining workflows within other workflows
func NewTestServiceWorkflowFunctions ¶
func NewTestServiceWorkflowFunctions() TestServiceWorkflowFunctions
type TestServiceWorkflows ¶
type TestServiceWorkflows interface {
// Foo initializes a new a(n) FooWorkflow implementation
Foo(ctx workflow.Context, input *FooWorkflowInput) (FooWorkflow, error)
}
TestServiceWorkflows provides methods for initializing new fx.stdtemporalfx.internal.v1.TestService workflow values
type TestTestServiceClient ¶
type TestTestServiceClient struct {
// contains filtered or unexported fields
}
TestClient provides a testsuite-compatible Client
func NewTestTestServiceClient ¶
func NewTestTestServiceClient(env *testsuite.TestWorkflowEnvironment, workflows TestServiceWorkflows, activities TestServiceActivities) *TestTestServiceClient
NewTestTestServiceClient initializes a new TestTestServiceClient value
func (*TestTestServiceClient) CancelWorkflow ¶
func (c *TestTestServiceClient) CancelWorkflow(ctx context.Context, workflowID string, runID string) error
CancelWorkflow requests cancellation of an existing workflow execution
func (*TestTestServiceClient) Foo ¶
func (c *TestTestServiceClient) Foo(ctx context.Context, req *FooInput, opts ...*FooOptions) (*FooOutput, error)
Foo executes a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow in the test environment
func (*TestTestServiceClient) FooAsync ¶
func (c *TestTestServiceClient) FooAsync(ctx context.Context, req *FooInput, options ...*FooOptions) (FooRun, error)
FooAsync executes a(n) fx.stdtemporalfx.internal.v1.TestService.Foo workflow in the test environment
func (*TestTestServiceClient) TerminateWorkflow ¶
func (c *TestTestServiceClient) TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details ...interface{}) error
TerminateWorkflow terminates an existing workflow execution