searchattributesv1xns

Documentation

Overview

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

protoc-gen-go_temporal 1.14.6-next (0ec9655dd1130535a5c8cfbda7a326aef9ac448a)
go go1.23.4
protoc (unknown)

source: example/searchattributes/v1/searchattributes.proto

Index

• func CancelExampleWorkflow(ctx workflow.Context, workflowID string, runID string) error
• func CancelExampleWorkflowAsync(ctx workflow.Context, workflowID string, runID string) workflow.Future
• func RegisterExampleActivities(r worker.ActivityRegistry, c v1.ExampleClient, options ...*ExampleOptions)
• func SearchAttributes(ctx workflow.Context, req *v1.SearchAttributesInput, ...) error
• type ExampleOptions
  • func NewExampleOptions() *ExampleOptions
  • func (opts *ExampleOptions) WithErrorConverter(errorConverter func(error) error) *ExampleOptions
  • func (opts *ExampleOptions) WithFilter(filter func(string) string) *ExampleOptions
• type SearchAttributesRun
  • func SearchAttributesAsync(ctx workflow.Context, req *v1.SearchAttributesInput, ...) (SearchAttributesRun, error)
• type SearchAttributesWorkflowOptions
  • func NewSearchAttributesWorkflowOptions() *SearchAttributesWorkflowOptions
  • func (opts *SearchAttributesWorkflowOptions) WithActivityOptions(ao workflow.ActivityOptions) *SearchAttributesWorkflowOptions
  • func (opts *SearchAttributesWorkflowOptions) WithDetached(d bool) *SearchAttributesWorkflowOptions
  • func (opts *SearchAttributesWorkflowOptions) WithHeartbeatInterval(d time.Duration) *SearchAttributesWorkflowOptions
  • func (opts *SearchAttributesWorkflowOptions) WithParentClosePolicy(policy enumsv1.ParentClosePolicy) *SearchAttributesWorkflowOptions
  • func (opts *SearchAttributesWorkflowOptions) WithStartWorkflow(swo client.StartWorkflowOptions) *SearchAttributesWorkflowOptions

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 RegisterExampleActivities

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

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

func SearchAttributes

func SearchAttributes(ctx workflow.Context, req *v1.SearchAttributesInput, opts ...*SearchAttributesWorkflowOptions) error

SearchAttributes executes a(n) example.searchattributes.v1.Example.SearchAttributes workflow and blocks until error or response is received

Types

type ExampleOptions

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

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

func NewExampleOptions

func NewExampleOptions() *ExampleOptions

NewExampleOptions initializes a new ExampleOptions value

func (*ExampleOptions) WithErrorConverter

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

WithErrorConverter overrides the default error converter applied to xns activity errors

func (*ExampleOptions) WithFilter

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

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

type SearchAttributesRun

type SearchAttributesRun 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
}

SearchAttributesRun provides a handle to a example.searchattributes.v1.Example.SearchAttributes workflow execution

func SearchAttributesAsync

func SearchAttributesAsync(ctx workflow.Context, req *v1.SearchAttributesInput, opts ...*SearchAttributesWorkflowOptions) (SearchAttributesRun, error)

SearchAttributesAsync executes a(n) example.searchattributes.v1.Example.SearchAttributes workflow and returns a handle to the underlying activity

type SearchAttributesWorkflowOptions

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

SearchAttributesWorkflowOptions are used to configure a(n) example.searchattributes.v1.Example.SearchAttributes workflow execution

func NewSearchAttributesWorkflowOptions

func NewSearchAttributesWorkflowOptions() *SearchAttributesWorkflowOptions

NewSearchAttributesWorkflowOptions initializes a new SearchAttributesWorkflowOptions value

func (*SearchAttributesWorkflowOptions) WithActivityOptions

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

WithActivityOptions can be used to customize the activity options

func (*SearchAttributesWorkflowOptions) WithDetached

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

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

func (*SearchAttributesWorkflowOptions) WithHeartbeatInterval

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

WithHeartbeatInterval can be used to customize the activity heartbeat interval

func (*SearchAttributesWorkflowOptions) WithParentClosePolicy

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

WithParentClosePolicy can be used to customize the cancellation propagation behavior

func (*SearchAttributesWorkflowOptions) WithStartWorkflow

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

WithStartWorkflowOptions can be used to customize the start workflow options