xnsv1

package
v1.12.0 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2024 License: MIT Imports: 32 Imported by: 0

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

Constants

View Source 
const (
	CreateFooWorkflowName = "example.xns.v1.Example.CreateFoo"
)

example.xns.v1.Example workflow names

View Source 
const ExampleTaskQueue = "example-v1"

ExampleTaskQueue is the default task-queue for a example.xns.v1.Example worker

View Source 
const (
	GetFooProgressQueryName = "example.xns.v1.Example.GetFooProgress"
)

example.xns.v1.Example query names

View Source 
const (
	NotifyActivityName = "example.xns.v1.Example.Notify"
)

example.xns.v1.Example activity names

View Source 
const (
	ProvisionFooWorkflowName = "example.xns.v1.Xns.ProvisionFoo"
)

example.xns.v1.Xns workflow names

View Source 
const (
	SetFooProgressSignalName = "example.xns.v1.Example.SetFooProgress"
)

example.xns.v1.Example signal names

View Source 
const (
	UpdateFooProgressUpdateName = "example.xns.v1.Example.UpdateFooProgress"
)

example.xns.v1.Example update names

View Source 
const XnsTaskQueue = "xns-v1"

XnsTaskQueue is the default task-queue for a example.xns.v1.Xns worker

Variables

View Source 
var (
	Foo_Status_name = map[int32]string{
		0: "FOO_STATUS_UNSPECIFIED",
		1: "FOO_STATUS_READY",
		2: "FOO_STATUS_CREATING",
	}
	Foo_Status_value = map[string]int32{
		"FOO_STATUS_UNSPECIFIED": 0,
		"FOO_STATUS_READY":       1,
		"FOO_STATUS_CREATING":    2,
	}
)

Enum value maps for Foo_Status.

View Source 
var (
	// CreateFoo creates a new foo operation
	CreateFooFunction func(workflow.Context, *CreateFooRequest) (*CreateFooResponse, error)
)

Reference to generated workflow functions

View Source 
var (
	CreateFooIdexpression = expression.MustParseExpression("create-foo/${! name.slug() }")
)

example.xns.v1.Example workflow id expressions

View Source 
var File_example_xns_v1_xns_proto protoreflect.FileDescriptor
View Source 
var (
	// ProvisionFooFunction implements a "example.xns.v1.Xns.ProvisionFoo" workflow
	ProvisionFooFunction func(workflow.Context, *ProvisionFooRequest) (*ProvisionFooResponse, error)
)

Reference to generated workflow functions

View Source 
var (
	ProvisionFooIdexpression = expression.MustParseExpression("provision-foo/${! name.slug() }")
)

example.xns.v1.Xns workflow id expressions

View Source 
var (
	UpdateFooProgressIdexpression = expression.MustParseExpression("update-progress/${! progress.string() }")
)

example.xns.v1.Example update id expressions

Functions

func NewExampleCli 

func NewExampleCli(options ...*ExampleCliOptions) (*v2.App, error)

NewExampleCli initializes a cli for a(n) example.xns.v1.Example service

func NewExampleCliCommand 

func NewExampleCliCommand(options ...*ExampleCliOptions) (*v2.Command, error)

NewExampleCliCommand initializes a cli command for a example.xns.v1.Example service with subcommands for each query, signal, update, and workflow

func NewExampleClientOptions 

func NewExampleClientOptions() *exampleClientOptions

NewExampleClientOptions initializes a new exampleClientOptions value

func NewXnsCli 

func NewXnsCli(options ...*XnsCliOptions) (*v2.App, error)

NewXnsCli initializes a cli for a(n) example.xns.v1.Xns service

func NewXnsCliCommand 

func NewXnsCliCommand(options ...*XnsCliOptions) (*v2.Command, error)

NewXnsCliCommand initializes a cli command for a example.xns.v1.Xns service with subcommands for each query, signal, update, and workflow

func NewXnsClientOptions 

func NewXnsClientOptions() *xnsClientOptions

NewXnsClientOptions initializes a new xnsClientOptions value

func Notify 

func Notify(ctx workflow.Context, req *NotifyRequest, options ...*NotifyActivityOptions) error

Notify sends a notification

func NotifyLocal 

func NotifyLocal(ctx workflow.Context, req *NotifyRequest, options ...*NotifyLocalActivityOptions) error

Notify sends a notification

func RegisterCreateFooWorkflow 

func RegisterCreateFooWorkflow(r worker.WorkflowRegistry, wf func(workflow.Context, *CreateFooWorkflowInput) (CreateFooWorkflow, error))

RegisterCreateFooWorkflow registers a example.xns.v1.Example.CreateFoo workflow with the given worker

func RegisterExampleActivities 

func RegisterExampleActivities(r worker.ActivityRegistry, activities ExampleActivities)

RegisterExampleActivities registers activities with a worker

func RegisterExampleWorkflows 

func RegisterExampleWorkflows(r worker.WorkflowRegistry, workflows ExampleWorkflows)

RegisterExampleWorkflows registers example.xns.v1.Example workflows with the given worker

func RegisterNotifyActivity 

func RegisterNotifyActivity(r worker.ActivityRegistry, fn func(context.Context, *NotifyRequest) error)

RegisterNotifyActivity registers a example.xns.v1.Example.Notify activity

func RegisterProvisionFooWorkflow 

func RegisterProvisionFooWorkflow(r worker.WorkflowRegistry, wf func(workflow.Context, *ProvisionFooWorkflowInput) (ProvisionFooWorkflow, error))

RegisterProvisionFooWorkflow registers a example.xns.v1.Xns.ProvisionFoo workflow with the given worker

func RegisterXnsActivities 

func RegisterXnsActivities(r worker.ActivityRegistry, activities XnsActivities)

RegisterXnsActivities registers activities with a worker

func RegisterXnsWorkflows 

func RegisterXnsWorkflows(r worker.WorkflowRegistry, workflows XnsWorkflows)

RegisterXnsWorkflows registers example.xns.v1.Xns workflows with the given worker

func SetFooProgressExternal 

func SetFooProgressExternal(ctx workflow.Context, workflowID string, runID string, req *SetFooProgressRequest) error

SetFooProgress sets the current status of a CreateFoo operation

func SetFooProgressExternalAsync 

func SetFooProgressExternalAsync(ctx workflow.Context, workflowID string, runID string, req *SetFooProgressRequest) workflow.Future

SetFooProgress sets the current status of a CreateFoo operation

func WithExampleSchemeTypes 

func WithExampleSchemeTypes() scheme.Option

WithExampleSchemeTypes registers all Example protobuf types with the given scheme

func WithXnsSchemeTypes 

func WithXnsSchemeTypes() scheme.Option

WithXnsSchemeTypes registers all Xns protobuf types with the given scheme

Types

type CreateFooChildOptions 

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

CreateFooChildOptions provides configuration for a example.xns.v1.Example.CreateFoo workflow operation

func NewCreateFooChildOptions 

func NewCreateFooChildOptions() *CreateFooChildOptions

NewCreateFooChildOptions initializes a new CreateFooChildOptions value

func (*CreateFooChildOptions) WithChildWorkflowOptions 

func (opts *CreateFooChildOptions) WithChildWorkflowOptions(options workflow.ChildWorkflowOptions) *CreateFooChildOptions

WithChildWorkflowOptions sets the initial client.StartWorkflowOptions

type CreateFooChildRun 

type CreateFooChildRun struct {
	Future workflow.ChildWorkflowFuture
}

CreateFooChildRun describes a child CreateFoo workflow run

func CreateFooChildAsync 

func CreateFooChildAsync(ctx workflow.Context, req *CreateFooRequest, options ...*CreateFooChildOptions) (*CreateFooChildRun, error)

CreateFoo creates a new foo operation

func (*CreateFooChildRun) Get 

func (r *CreateFooChildRun) Get(ctx workflow.Context) (*CreateFooResponse, error)

Get blocks until the workflow is completed, returning the response value

func (*CreateFooChildRun) Select 

func (r *CreateFooChildRun) Select(sel workflow.Selector, fn func(*CreateFooChildRun)) workflow.Selector

Select adds this completion to the selector. Callback can be nil.

func (*CreateFooChildRun) SelectStart 

func (r *CreateFooChildRun) SelectStart(sel workflow.Selector, fn func(*CreateFooChildRun)) workflow.Selector

SelectStart adds waiting for start to the selector. Callback can be nil.

func (*CreateFooChildRun) SetFooProgress 

func (r *CreateFooChildRun) SetFooProgress(ctx workflow.Context, input *SetFooProgressRequest) error

SetFooProgress sends a(n) "example.xns.v1.Example.SetFooProgress" signal request to the child workflow

func (*CreateFooChildRun) SetFooProgressAsync 

func (r *CreateFooChildRun) SetFooProgressAsync(ctx workflow.Context, input *SetFooProgressRequest) workflow.Future

SetFooProgressAsync sends a(n) "example.xns.v1.Example.SetFooProgress" signal request to the child workflow

func (*CreateFooChildRun) WaitStart 

func (r *CreateFooChildRun) WaitStart(ctx workflow.Context) (*workflow.Execution, error)

WaitStart waits for the child workflow to start

type CreateFooOptions 

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

CreateFooOptions provides configuration for a example.xns.v1.Example.CreateFoo workflow operation

func NewCreateFooOptions 

func NewCreateFooOptions() *CreateFooOptions

NewCreateFooOptions initializes a new CreateFooOptions value

func (*CreateFooOptions) WithStartWorkflowOptions 

func (opts *CreateFooOptions) WithStartWorkflowOptions(options client.StartWorkflowOptions) *CreateFooOptions

WithStartWorkflowOptions sets the initial client.StartWorkflowOptions

type CreateFooRequest 

type CreateFooRequest struct {

	// unique foo name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

CreateFooRequest describes the input to a CreateFoo workflow

func UnmarshalCliFlagsToCreateFooRequest 

func UnmarshalCliFlagsToCreateFooRequest(cmd *v2.Context) (*CreateFooRequest, error)

UnmarshalCliFlagsToCreateFooRequest unmarshals a CreateFooRequest from command line flags

func (*CreateFooRequest) Descriptor deprecated 

func (*CreateFooRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFooRequest.ProtoReflect.Descriptor instead.

func (*CreateFooRequest) GetName 

func (x *CreateFooRequest) GetName() string

func (*CreateFooRequest) ProtoMessage 

func (*CreateFooRequest) ProtoMessage()

func (*CreateFooRequest) ProtoReflect 

func (x *CreateFooRequest) ProtoReflect() protoreflect.Message

func (*CreateFooRequest) Reset 

func (x *CreateFooRequest) Reset()

func (*CreateFooRequest) String 

func (x *CreateFooRequest) String() string

type CreateFooResponse 

type CreateFooResponse struct {
	Foo *Foo `protobuf:"bytes,1,opt,name=foo,proto3" json:"foo,omitempty"`
	// contains filtered or unexported fields
}

SampleWorkflowWithMutexResponse describes the output from a CreateFoo workflow

func CreateFooChild 

func CreateFooChild(ctx workflow.Context, req *CreateFooRequest, options ...*CreateFooChildOptions) (*CreateFooResponse, error)

CreateFoo creates a new foo operation

func (*CreateFooResponse) Descriptor deprecated 

func (*CreateFooResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateFooResponse.ProtoReflect.Descriptor instead.

func (*CreateFooResponse) GetFoo 

func (x *CreateFooResponse) GetFoo() *Foo

func (*CreateFooResponse) ProtoMessage 

func (*CreateFooResponse) ProtoMessage()

func (*CreateFooResponse) ProtoReflect 

func (x *CreateFooResponse) ProtoReflect() protoreflect.Message

func (*CreateFooResponse) Reset 

func (x *CreateFooResponse) Reset()

func (*CreateFooResponse) String 

func (x *CreateFooResponse) String() string

type CreateFooRun 

type CreateFooRun 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) (*CreateFooResponse, 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

	// GetFooProgress returns the status of a CreateFoo operation
	GetFooProgress(ctx context.Context) (*GetFooProgressResponse, error)

	// SetFooProgress sets the current status of a CreateFoo operation
	SetFooProgress(ctx context.Context, req *SetFooProgressRequest) error

	// UpdateFooProgress sets the current status of a CreateFoo operation
	UpdateFooProgress(ctx context.Context, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (*GetFooProgressResponse, error)

	// UpdateFooProgress sets the current status of a CreateFoo operation
	UpdateFooProgressAsync(ctx context.Context, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (UpdateFooProgressHandle, error)
}

CreateFooRun describes a(n) example.xns.v1.Example.CreateFoo workflow run

type CreateFooWorkflow 

type CreateFooWorkflow interface {
	// Execute defines the entrypoint to a(n) example.xns.v1.Example.CreateFoo workflow
	Execute(ctx workflow.Context) (*CreateFooResponse, error)

	// GetFooProgress returns the status of a CreateFoo operation
	GetFooProgress() (*GetFooProgressResponse, error)

	// UpdateFooProgress sets the current status of a CreateFoo operation
	UpdateFooProgress(workflow.Context, *SetFooProgressRequest) (*GetFooProgressResponse, error)
}

CreateFoo creates a new foo operation

workflow details: (name: "example.xns.v1.Example.CreateFoo", id: "create-foo/${! name.slug() }")

type CreateFooWorkflowInput 

type CreateFooWorkflowInput struct {
	Req            *CreateFooRequest
	SetFooProgress *SetFooProgressSignal
}

CreateFooWorkflowInput describes the input to a(n) example.xns.v1.Example.CreateFoo workflow constructor

type ExampleActivities 

type ExampleActivities interface {
	// Notify sends a notification
	Notify(ctx context.Context, req *NotifyRequest) error
}

ExampleActivities describes available worker activities

type ExampleCliOptions 

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

ExampleCliOptions describes runtime configuration for example.xns.v1.Example cli

func NewExampleCliOptions 

func NewExampleCliOptions() *ExampleCliOptions

NewExampleCliOptions initializes a new ExampleCliOptions value

func (*ExampleCliOptions) WithAfter 

func (opts *ExampleCliOptions) WithAfter(fn func(*v2.Context) error) *ExampleCliOptions

WithAfter injects a custom After hook to be run after any command invocation

func (*ExampleCliOptions) WithBefore 

func (opts *ExampleCliOptions) WithBefore(fn func(*v2.Context) error) *ExampleCliOptions

WithBefore injects a custom Before hook to be run prior to any command invocation

func (*ExampleCliOptions) WithClient 

func (opts *ExampleCliOptions) WithClient(fn func(*v2.Context) (client.Client, error)) *ExampleCliOptions

WithClient provides a Temporal client factory for use by commands

func (*ExampleCliOptions) WithWorker 

func (opts *ExampleCliOptions) WithWorker(fn func(*v2.Context, client.Client) (worker.Worker, error)) *ExampleCliOptions

WithWorker provides an method for initializing a worker

type ExampleClient 

type ExampleClient interface {
	// CreateFoo creates a new foo operation
	CreateFoo(ctx context.Context, req *CreateFooRequest, opts ...*CreateFooOptions) (*CreateFooResponse, error)

	// CreateFooAsync starts a(n) example.xns.v1.Example.CreateFoo workflow and returns a handle to the workflow run
	CreateFooAsync(ctx context.Context, req *CreateFooRequest, opts ...*CreateFooOptions) (CreateFooRun, error)

	// GetCreateFoo retrieves a handle to an existing example.xns.v1.Example.CreateFoo workflow execution
	GetCreateFoo(ctx context.Context, workflowID string, runID string) CreateFooRun

	// CreateFooWithSetFooProgress sends a(n) example.xns.v1.Example.SetFooProgress signal to a(n) example.xns.v1.Example.CreateFoo workflow, starting it if necessary, and blocks until workflow completion
	CreateFooWithSetFooProgress(ctx context.Context, req *CreateFooRequest, signal *SetFooProgressRequest, opts ...*CreateFooOptions) (*CreateFooResponse, 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 workflow execution
	CreateFooWithSetFooProgressAsync(ctx context.Context, req *CreateFooRequest, signal *SetFooProgressRequest, opts ...*CreateFooOptions) (CreateFooRun, error)

	// 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

	// GetFooProgress returns the status of a CreateFoo operation
	GetFooProgress(ctx context.Context, workflowID string, runID string) (*GetFooProgressResponse, error)

	// SetFooProgress sets the current status of a CreateFoo operation
	SetFooProgress(ctx context.Context, workflowID string, runID string, signal *SetFooProgressRequest) error

	// UpdateFooProgress sets the current status of a CreateFoo operation
	UpdateFooProgress(ctx context.Context, workflowID string, runID string, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (*GetFooProgressResponse, error)

	// UpdateFooProgressAsync starts a(n) example.xns.v1.Example.UpdateFooProgress update and returns a handle to the workflow update
	UpdateFooProgressAsync(ctx context.Context, workflowID string, runID string, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (UpdateFooProgressHandle, error)

	// GetUpdateFooProgress retrieves a handle to an existing example.xns.v1.Example.UpdateFooProgress update
	GetUpdateFooProgress(ctx context.Context, req client.GetWorkflowUpdateHandleOptions) (UpdateFooProgressHandle, error)
}

ExampleClient describes a client for a(n) example.xns.v1.Example worker

func NewExampleClient 

func NewExampleClient(c client.Client, options ...*exampleClientOptions) ExampleClient

NewExampleClient initializes a new example.xns.v1.Example client

func NewExampleClientWithOptions 

func NewExampleClientWithOptions(c client.Client, opts client.Options, options ...*exampleClientOptions) (ExampleClient, error)

NewExampleClientWithOptions initializes a new Example client with the given options

type ExampleWorkflowFunctions added in v1.12.0 

type ExampleWorkflowFunctions interface {
	// CreateFoo creates a new foo operation
	CreateFoo(workflow.Context, *CreateFooRequest) (*CreateFooResponse, error)
}

ExampleWorkflowFunctions describes a mockable dependency for inlining workflows within other workflows

func NewExampleWorkflowFunctions added in v1.12.0 

func NewExampleWorkflowFunctions() ExampleWorkflowFunctions

type ExampleWorkflows 

type ExampleWorkflows interface {
	// CreateFoo creates a new foo operation
	CreateFoo(ctx workflow.Context, input *CreateFooWorkflowInput) (CreateFooWorkflow, error)
}

ExampleWorkflows provides methods for initializing new example.xns.v1.Example workflow values

type Foo 

type Foo struct {
	Name   string     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Status Foo_Status `protobuf:"varint,2,opt,name=status,proto3,enum=example.xns.v1.Foo_Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Foo describes an illustrative foo resource

func (*Foo) Descriptor deprecated 

func (*Foo) Descriptor() ([]byte, []int)

Deprecated: Use Foo.ProtoReflect.Descriptor instead.

func (*Foo) GetName 

func (x *Foo) GetName() string

func (*Foo) GetStatus 

func (x *Foo) GetStatus() Foo_Status

func (*Foo) ProtoMessage 

func (*Foo) ProtoMessage()

func (*Foo) ProtoReflect 

func (x *Foo) ProtoReflect() protoreflect.Message

func (*Foo) Reset 

func (x *Foo) Reset()

func (*Foo) String 

func (x *Foo) String() string

type Foo_Status 

type Foo_Status int32
const (
	Foo_FOO_STATUS_UNSPECIFIED Foo_Status = 0
	Foo_FOO_STATUS_READY       Foo_Status = 1
	Foo_FOO_STATUS_CREATING    Foo_Status = 2
)

func (Foo_Status) Descriptor 

func (Foo_Status) Descriptor() protoreflect.EnumDescriptor

func (Foo_Status) Enum 

func (x Foo_Status) Enum() *Foo_Status

func (Foo_Status) EnumDescriptor deprecated 

func (Foo_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use Foo_Status.Descriptor instead.

func (Foo_Status) Number 

func (x Foo_Status) Number() protoreflect.EnumNumber

func (Foo_Status) String 

func (x Foo_Status) String() string

func (Foo_Status) Type 

func (Foo_Status) Type() protoreflect.EnumType

type GetFooProgressResponse 

type GetFooProgressResponse struct {
	Progress float32    `protobuf:"fixed32,1,opt,name=progress,proto3" json:"progress,omitempty"`
	Status   Foo_Status `protobuf:"varint,2,opt,name=status,proto3,enum=example.xns.v1.Foo_Status" json:"status,omitempty"`
	// contains filtered or unexported fields
}

GetFooProgressResponse describes the output from a GetFooProgress query

func (*GetFooProgressResponse) Descriptor deprecated 

func (*GetFooProgressResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetFooProgressResponse.ProtoReflect.Descriptor instead.

func (*GetFooProgressResponse) GetProgress 

func (x *GetFooProgressResponse) GetProgress() float32

func (*GetFooProgressResponse) GetStatus 

func (x *GetFooProgressResponse) GetStatus() Foo_Status

func (*GetFooProgressResponse) ProtoMessage 

func (*GetFooProgressResponse) ProtoMessage()

func (*GetFooProgressResponse) ProtoReflect 

func (x *GetFooProgressResponse) ProtoReflect() protoreflect.Message

func (*GetFooProgressResponse) Reset 

func (x *GetFooProgressResponse) Reset()

func (*GetFooProgressResponse) String 

func (x *GetFooProgressResponse) String() string

type NotifyActivityOptions 

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

NotifyActivityOptions provides configuration for a(n) example.xns.v1.Example.Notify activity

func NewNotifyActivityOptions 

func NewNotifyActivityOptions() *NotifyActivityOptions

NewNotifyActivityOptions sets default ActivityOptions

func (*NotifyActivityOptions) WithActivityOptions 

func (opts *NotifyActivityOptions) WithActivityOptions(options workflow.ActivityOptions) *NotifyActivityOptions

WithActivityOptions sets default ActivityOptions

type NotifyFuture 

type NotifyFuture struct {
	Future workflow.Future
}

NotifyFuture describes a(n) example.xns.v1.Example.Notify activity execution

func NotifyAsync 

func NotifyAsync(ctx workflow.Context, req *NotifyRequest, options ...*NotifyActivityOptions) *NotifyFuture

Notify sends a notification

func NotifyLocalAsync 

func NotifyLocalAsync(ctx workflow.Context, req *NotifyRequest, options ...*NotifyLocalActivityOptions) *NotifyFuture

Notify sends a notification

func (*NotifyFuture) Get 

func (f *NotifyFuture) Get(ctx workflow.Context) error

Get blocks on the activity's completion, returning the response

func (*NotifyFuture) Select 

func (f *NotifyFuture) Select(sel workflow.Selector, fn func(*NotifyFuture)) workflow.Selector

Select adds the activity's completion to the selector, callback can be nil

type NotifyLocalActivityOptions 

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

NotifyLocalActivityOptions provides configuration for a local example.xns.v1.Example.Notify activity

func NewNotifyLocalActivityOptions 

func NewNotifyLocalActivityOptions() *NotifyLocalActivityOptions

NewNotifyLocalActivityOptions sets default LocalActivityOptions

func (*NotifyLocalActivityOptions) Local 

func (opts *NotifyLocalActivityOptions) Local(fn func(context.Context, *NotifyRequest) error) *NotifyLocalActivityOptions

Local provides a local example.xns.v1.Example.Notify activity implementation

func (*NotifyLocalActivityOptions) WithLocalActivityOptions 

func (opts *NotifyLocalActivityOptions) WithLocalActivityOptions(options workflow.LocalActivityOptions) *NotifyLocalActivityOptions

WithLocalActivityOptions sets default LocalActivityOptions

type NotifyRequest 

type NotifyRequest struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

NotifyRequest describes the input to a Notify activity

func (*NotifyRequest) Descriptor deprecated 

func (*NotifyRequest) Descriptor() ([]byte, []int)

Deprecated: Use NotifyRequest.ProtoReflect.Descriptor instead.

func (*NotifyRequest) GetMessage 

func (x *NotifyRequest) GetMessage() string

func (*NotifyRequest) ProtoMessage 

func (*NotifyRequest) ProtoMessage()

func (*NotifyRequest) ProtoReflect 

func (x *NotifyRequest) ProtoReflect() protoreflect.Message

func (*NotifyRequest) Reset 

func (x *NotifyRequest) Reset()

func (*NotifyRequest) String 

func (x *NotifyRequest) String() string

type ProvisionFooChildOptions 

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

ProvisionFooChildOptions provides configuration for a example.xns.v1.Xns.ProvisionFoo workflow operation

func NewProvisionFooChildOptions 

func NewProvisionFooChildOptions() *ProvisionFooChildOptions

NewProvisionFooChildOptions initializes a new ProvisionFooChildOptions value

func (*ProvisionFooChildOptions) WithChildWorkflowOptions 

func (opts *ProvisionFooChildOptions) WithChildWorkflowOptions(options workflow.ChildWorkflowOptions) *ProvisionFooChildOptions

WithChildWorkflowOptions sets the initial client.StartWorkflowOptions

type ProvisionFooChildRun 

type ProvisionFooChildRun struct {
	Future workflow.ChildWorkflowFuture
}

ProvisionFooChildRun describes a child ProvisionFoo workflow run

func ProvisionFooChildAsync 

func ProvisionFooChildAsync(ctx workflow.Context, req *ProvisionFooRequest, options ...*ProvisionFooChildOptions) (*ProvisionFooChildRun, error)

ProvisionFooChildAsync starts a child example.xns.v1.Xns.ProvisionFoo workflow and returns a handle to the child workflow run

func (*ProvisionFooChildRun) Get 

func (r *ProvisionFooChildRun) Get(ctx workflow.Context) (*ProvisionFooResponse, error)

Get blocks until the workflow is completed, returning the response value

func (*ProvisionFooChildRun) Select 

func (r *ProvisionFooChildRun) Select(sel workflow.Selector, fn func(*ProvisionFooChildRun)) workflow.Selector

Select adds this completion to the selector. Callback can be nil.

func (*ProvisionFooChildRun) SelectStart 

func (r *ProvisionFooChildRun) SelectStart(sel workflow.Selector, fn func(*ProvisionFooChildRun)) workflow.Selector

SelectStart adds waiting for start to the selector. Callback can be nil.

func (*ProvisionFooChildRun) WaitStart 

func (r *ProvisionFooChildRun) WaitStart(ctx workflow.Context) (*workflow.Execution, error)

WaitStart waits for the child workflow to start

type ProvisionFooOptions 

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

ProvisionFooOptions provides configuration for a example.xns.v1.Xns.ProvisionFoo workflow operation

func NewProvisionFooOptions 

func NewProvisionFooOptions() *ProvisionFooOptions

NewProvisionFooOptions initializes a new ProvisionFooOptions value

func (*ProvisionFooOptions) WithStartWorkflowOptions 

func (opts *ProvisionFooOptions) WithStartWorkflowOptions(options client.StartWorkflowOptions) *ProvisionFooOptions

WithStartWorkflowOptions sets the initial client.StartWorkflowOptions

type ProvisionFooRequest 

type ProvisionFooRequest struct {

	// unique foo name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

ProvisionFooRequest describes the input to a ProvisionFoo workflow

func UnmarshalCliFlagsToProvisionFooRequest 

func UnmarshalCliFlagsToProvisionFooRequest(cmd *v2.Context) (*ProvisionFooRequest, error)

UnmarshalCliFlagsToProvisionFooRequest unmarshals a ProvisionFooRequest from command line flags

func (*ProvisionFooRequest) Descriptor deprecated 

func (*ProvisionFooRequest) Descriptor() ([]byte, []int)

Deprecated: Use ProvisionFooRequest.ProtoReflect.Descriptor instead.

func (*ProvisionFooRequest) GetName 

func (x *ProvisionFooRequest) GetName() string

func (*ProvisionFooRequest) ProtoMessage 

func (*ProvisionFooRequest) ProtoMessage()

func (*ProvisionFooRequest) ProtoReflect 

func (x *ProvisionFooRequest) ProtoReflect() protoreflect.Message

func (*ProvisionFooRequest) Reset 

func (x *ProvisionFooRequest) Reset()

func (*ProvisionFooRequest) String 

func (x *ProvisionFooRequest) String() string

type ProvisionFooResponse 

type ProvisionFooResponse struct {
	Foo *Foo `protobuf:"bytes,1,opt,name=foo,proto3" json:"foo,omitempty"`
	// contains filtered or unexported fields
}

SampleWorkflowWithMutexResponse describes the output from a ProvisionFoo workflow

func ProvisionFooChild 

func ProvisionFooChild(ctx workflow.Context, req *ProvisionFooRequest, options ...*ProvisionFooChildOptions) (*ProvisionFooResponse, error)

ProvisionFooChild executes a child example.xns.v1.Xns.ProvisionFoo workflow and blocks until error or response received

func (*ProvisionFooResponse) Descriptor deprecated 

func (*ProvisionFooResponse) Descriptor() ([]byte, []int)

Deprecated: Use ProvisionFooResponse.ProtoReflect.Descriptor instead.

func (*ProvisionFooResponse) GetFoo 

func (x *ProvisionFooResponse) GetFoo() *Foo

func (*ProvisionFooResponse) ProtoMessage 

func (*ProvisionFooResponse) ProtoMessage()

func (*ProvisionFooResponse) ProtoReflect 

func (x *ProvisionFooResponse) ProtoReflect() protoreflect.Message

func (*ProvisionFooResponse) Reset 

func (x *ProvisionFooResponse) Reset()

func (*ProvisionFooResponse) String 

func (x *ProvisionFooResponse) String() string

type ProvisionFooRun 

type ProvisionFooRun 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) (*ProvisionFooResponse, 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
}

ProvisionFooRun describes a(n) example.xns.v1.Xns.ProvisionFoo workflow run

type ProvisionFooWorkflow 

type ProvisionFooWorkflow interface {
	// Execute defines the entrypoint to a(n) example.xns.v1.Xns.ProvisionFoo workflow
	Execute(ctx workflow.Context) (*ProvisionFooResponse, error)
}

ProvisionFooWorkflow describes a(n) example.xns.v1.Xns.ProvisionFoo workflow implementation

workflow details: (id: "provision-foo/${! name.slug() }")

type ProvisionFooWorkflowInput 

type ProvisionFooWorkflowInput struct {
	Req *ProvisionFooRequest
}

ProvisionFooWorkflowInput describes the input to a(n) example.xns.v1.Xns.ProvisionFoo workflow constructor

type SetFooProgressRequest 

type SetFooProgressRequest struct {

	// value of current workflow progress
	Progress float32 `protobuf:"fixed32,1,opt,name=progress,proto3" json:"progress,omitempty"`
	// contains filtered or unexported fields
}

SetFooProgressRequest describes the input to a SetFooProgress signal

func UnmarshalCliFlagsToSetFooProgressRequest 

func UnmarshalCliFlagsToSetFooProgressRequest(cmd *v2.Context) (*SetFooProgressRequest, error)

UnmarshalCliFlagsToSetFooProgressRequest unmarshals a SetFooProgressRequest from command line flags

func (*SetFooProgressRequest) Descriptor deprecated 

func (*SetFooProgressRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetFooProgressRequest.ProtoReflect.Descriptor instead.

func (*SetFooProgressRequest) GetProgress 

func (x *SetFooProgressRequest) GetProgress() float32

func (*SetFooProgressRequest) ProtoMessage 

func (*SetFooProgressRequest) ProtoMessage()

func (*SetFooProgressRequest) ProtoReflect 

func (x *SetFooProgressRequest) ProtoReflect() protoreflect.Message

func (*SetFooProgressRequest) Reset 

func (x *SetFooProgressRequest) Reset()

func (*SetFooProgressRequest) String 

func (x *SetFooProgressRequest) String() string

type SetFooProgressSignal 

type SetFooProgressSignal struct {
	Channel workflow.ReceiveChannel
}

SetFooProgressSignal describes a(n) example.xns.v1.Example.SetFooProgress signal

func NewSetFooProgressSignal 

func NewSetFooProgressSignal(ctx workflow.Context) *SetFooProgressSignal

NewSetFooProgressSignal initializes a new example.xns.v1.Example.SetFooProgress signal wrapper

func (*SetFooProgressSignal) Receive 

func (s *SetFooProgressSignal) Receive(ctx workflow.Context) (*SetFooProgressRequest, bool)

Receive blocks until a(n) example.xns.v1.Example.SetFooProgress signal is received

func (*SetFooProgressSignal) ReceiveAsync 

func (s *SetFooProgressSignal) ReceiveAsync() *SetFooProgressRequest

ReceiveAsync checks for a example.xns.v1.Example.SetFooProgress signal without blocking

func (*SetFooProgressSignal) ReceiveWithTimeout 

func (s *SetFooProgressSignal) ReceiveWithTimeout(ctx workflow.Context, timeout time.Duration) (resp *SetFooProgressRequest, ok bool, more bool)

ReceiveWithTimeout blocks until a(n) example.xns.v1.Example.SetFooProgress signal is received or timeout expires. Returns more value of false when Channel is closed. Returns ok value of false when no value was found in the channel for the duration of timeout or the ctx was canceled. resp will be nil if ok is false.

func (*SetFooProgressSignal) Select 

func (s *SetFooProgressSignal) Select(sel workflow.Selector, fn func(*SetFooProgressRequest)) workflow.Selector

Select checks for a(n) example.xns.v1.Example.SetFooProgress signal without blocking

type TestExampleClient 

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

TestClient provides a testsuite-compatible Client

func NewTestExampleClient 

func NewTestExampleClient(env *testsuite.TestWorkflowEnvironment, workflows ExampleWorkflows, activities ExampleActivities) *TestExampleClient

NewTestExampleClient initializes a new TestExampleClient value

func (*TestExampleClient) CancelWorkflow 

func (c *TestExampleClient) CancelWorkflow(ctx context.Context, workflowID string, runID string) error

CancelWorkflow requests cancellation of an existing workflow execution

func (*TestExampleClient) CreateFoo 

func (c *TestExampleClient) CreateFoo(ctx context.Context, req *CreateFooRequest, opts ...*CreateFooOptions) (*CreateFooResponse, error)

CreateFoo executes a(n) example.xns.v1.Example.CreateFoo workflow in the test environment

func (*TestExampleClient) CreateFooAsync 

func (c *TestExampleClient) CreateFooAsync(ctx context.Context, req *CreateFooRequest, options ...*CreateFooOptions) (CreateFooRun, error)

CreateFooAsync executes a(n) example.xns.v1.Example.CreateFoo workflow in the test environment

func (*TestExampleClient) CreateFooWithSetFooProgress 

func (c *TestExampleClient) CreateFooWithSetFooProgress(ctx context.Context, req *CreateFooRequest, signal *SetFooProgressRequest, opts ...*CreateFooOptions) (*CreateFooResponse, error)

CreateFooWithSetFooProgress sends a(n) example.xns.v1.Example.SetFooProgress signal to a(n) example.xns.v1.Example.CreateFoo workflow, starting it if necessary

func (*TestExampleClient) CreateFooWithSetFooProgressAsync 

func (c *TestExampleClient) CreateFooWithSetFooProgressAsync(ctx context.Context, req *CreateFooRequest, signal *SetFooProgressRequest, opts ...*CreateFooOptions) (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

func (*TestExampleClient) GetCreateFoo 

func (c *TestExampleClient) GetCreateFoo(ctx context.Context, workflowID string, runID string) CreateFooRun

GetCreateFoo is a noop

func (*TestExampleClient) GetFooProgress 

func (c *TestExampleClient) GetFooProgress(ctx context.Context, workflowID string, runID string) (*GetFooProgressResponse, error)

GetFooProgress executes a example.xns.v1.Example.GetFooProgress query

func (*TestExampleClient) GetUpdateFooProgress 

func (c *TestExampleClient) GetUpdateFooProgress(ctx context.Context, req client.GetWorkflowUpdateHandleOptions) (UpdateFooProgressHandle, error)

GetUpdateFooProgress retrieves a handle to an existing example.xns.v1.Example.UpdateFooProgress update

func (*TestExampleClient) SetFooProgress 

func (c *TestExampleClient) SetFooProgress(ctx context.Context, workflowID string, runID string, req *SetFooProgressRequest) error

SetFooProgress executes a example.xns.v1.Example.SetFooProgress signal

func (*TestExampleClient) TerminateWorkflow 

func (c *TestExampleClient) TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details ...interface{}) error

TerminateWorkflow terminates an existing workflow execution

func (*TestExampleClient) UpdateFooProgress 

func (c *TestExampleClient) UpdateFooProgress(ctx context.Context, workflowID string, runID string, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (*GetFooProgressResponse, error)

UpdateFooProgress executes a(n) example.xns.v1.Example.UpdateFooProgress update in the test environment

func (*TestExampleClient) UpdateFooProgressAsync 

func (c *TestExampleClient) UpdateFooProgressAsync(ctx context.Context, workflowID string, runID string, req *SetFooProgressRequest, opts ...*UpdateFooProgressOptions) (UpdateFooProgressHandle, error)

UpdateFooProgressAsync executes a(n) example.xns.v1.Example.UpdateFooProgress update in the test environment

type TestXnsClient 

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

TestClient provides a testsuite-compatible Client

func NewTestXnsClient 

func NewTestXnsClient(env *testsuite.TestWorkflowEnvironment, workflows XnsWorkflows, activities XnsActivities) *TestXnsClient

NewTestXnsClient initializes a new TestXnsClient value

func (*TestXnsClient) CancelWorkflow 

func (c *TestXnsClient) CancelWorkflow(ctx context.Context, workflowID string, runID string) error

CancelWorkflow requests cancellation of an existing workflow execution

func (*TestXnsClient) GetProvisionFoo 

func (c *TestXnsClient) GetProvisionFoo(ctx context.Context, workflowID string, runID string) ProvisionFooRun

GetProvisionFoo is a noop

func (*TestXnsClient) ProvisionFoo 

func (c *TestXnsClient) ProvisionFoo(ctx context.Context, req *ProvisionFooRequest, opts ...*ProvisionFooOptions) (*ProvisionFooResponse, error)

ProvisionFoo executes a(n) example.xns.v1.Xns.ProvisionFoo workflow in the test environment

func (*TestXnsClient) ProvisionFooAsync 

func (c *TestXnsClient) ProvisionFooAsync(ctx context.Context, req *ProvisionFooRequest, options ...*ProvisionFooOptions) (ProvisionFooRun, error)

ProvisionFooAsync executes a(n) example.xns.v1.Xns.ProvisionFoo workflow in the test environment

func (*TestXnsClient) TerminateWorkflow 

func (c *TestXnsClient) TerminateWorkflow(ctx context.Context, workflowID string, runID string, reason string, details ...interface{}) error

TerminateWorkflow terminates an existing workflow execution

type UpdateFooProgressHandle 

type UpdateFooProgressHandle interface {
	// WorkflowID returns the workflow ID
	WorkflowID() string
	// RunID returns the workflow instance ID
	RunID() string
	// UpdateID returns the update ID
	UpdateID() string
	// Get blocks until the workflow is complete and returns the result
	Get(ctx context.Context) (*GetFooProgressResponse, error)
}

UpdateFooProgressHandle describes a(n) example.xns.v1.Example.UpdateFooProgress update handle

type UpdateFooProgressOptions 

type UpdateFooProgressOptions struct {
	Options *client.UpdateWorkflowWithOptionsRequest
}

UpdateFooProgressOptions provides configuration for a example.xns.v1.Example.UpdateFooProgress update operation

func NewUpdateFooProgressOptions 

func NewUpdateFooProgressOptions() *UpdateFooProgressOptions

NewUpdateFooProgressOptions initializes a new UpdateFooProgressOptions value

func (*UpdateFooProgressOptions) WithUpdateWorkflowOptions 

func (opts *UpdateFooProgressOptions) WithUpdateWorkflowOptions(options client.UpdateWorkflowWithOptionsRequest) *UpdateFooProgressOptions

WithUpdateWorkflowOptions sets the initial client.UpdateWorkflowWithOptionsRequest

type XnsActivities 

type XnsActivities interface{}

XnsActivities describes available worker activities

type XnsCliOptions 

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

XnsCliOptions describes runtime configuration for example.xns.v1.Xns cli

func NewXnsCliOptions 

func NewXnsCliOptions() *XnsCliOptions

NewXnsCliOptions initializes a new XnsCliOptions value

func (*XnsCliOptions) WithAfter 

func (opts *XnsCliOptions) WithAfter(fn func(*v2.Context) error) *XnsCliOptions

WithAfter injects a custom After hook to be run after any command invocation

func (*XnsCliOptions) WithBefore 

func (opts *XnsCliOptions) WithBefore(fn func(*v2.Context) error) *XnsCliOptions

WithBefore injects a custom Before hook to be run prior to any command invocation

func (*XnsCliOptions) WithClient 

func (opts *XnsCliOptions) WithClient(fn func(*v2.Context) (client.Client, error)) *XnsCliOptions

WithClient provides a Temporal client factory for use by commands

func (*XnsCliOptions) WithWorker 

func (opts *XnsCliOptions) WithWorker(fn func(*v2.Context, client.Client) (worker.Worker, error)) *XnsCliOptions

WithWorker provides an method for initializing a worker

type XnsClient 

type XnsClient interface {
	// ProvisionFoo executes a(n) example.xns.v1.Xns.ProvisionFoo workflow and blocks until error or response received
	ProvisionFoo(ctx context.Context, req *ProvisionFooRequest, opts ...*ProvisionFooOptions) (*ProvisionFooResponse, error)

	// ProvisionFooAsync starts a(n) example.xns.v1.Xns.ProvisionFoo workflow and returns a handle to the workflow run
	ProvisionFooAsync(ctx context.Context, req *ProvisionFooRequest, opts ...*ProvisionFooOptions) (ProvisionFooRun, error)

	// GetProvisionFoo retrieves a handle to an existing example.xns.v1.Xns.ProvisionFoo workflow execution
	GetProvisionFoo(ctx context.Context, workflowID string, runID string) ProvisionFooRun

	// 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
}

XnsClient describes a client for a(n) example.xns.v1.Xns worker

func NewXnsClient 

func NewXnsClient(c client.Client, options ...*xnsClientOptions) XnsClient

NewXnsClient initializes a new example.xns.v1.Xns client

func NewXnsClientWithOptions 

func NewXnsClientWithOptions(c client.Client, opts client.Options, options ...*xnsClientOptions) (XnsClient, error)

NewXnsClientWithOptions initializes a new Xns client with the given options

type XnsWorkflowFunctions added in v1.12.0 

type XnsWorkflowFunctions interface {
	// ProvisionFoo executes a "example.xns.v1.Xns.ProvisionFoo" workflow inline
	ProvisionFoo(workflow.Context, *ProvisionFooRequest) (*ProvisionFooResponse, error)
}

XnsWorkflowFunctions describes a mockable dependency for inlining workflows within other workflows

func NewXnsWorkflowFunctions added in v1.12.0 

func NewXnsWorkflowFunctions() XnsWorkflowFunctions

type XnsWorkflows 

type XnsWorkflows interface {
	// ProvisionFoo initializes a new a(n) ProvisionFooWorkflow implementation
	ProvisionFoo(ctx workflow.Context, input *ProvisionFooWorkflowInput) (ProvisionFooWorkflow, error)
}

XnsWorkflows provides methods for initializing new example.xns.v1.Xns workflow values

Source Files

View all Source files

Directories

Path Synopsis
Code generated by protoc-gen-go_temporal.
 Code generated by protoc-gen-go_temporal.

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.