tasks

package
v1.24.0-m1 Latest Latest
Warning

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

Go to latest
Published: Mar 5, 2024 License: MIT Imports: 17 Imported by: 3

Documentation

Overview

Package tasks is a generated GoMock package.

Index

Constants

View Source
const (
	CategoryIDTransfer    = 1
	CategoryIDTimer       = 2
	CategoryIDReplication = 3
	CategoryIDVisibility  = 4
	CategoryIDArchival    = 5
	CategoryIDMemoryTimer = 6
)
View Source
const (
	// SpeculativeWorkflowTaskScheduleToStartTimeout is the timeout for a speculative workflow task on a normal task queue.
	// Default ScheduleToStart timeout for a sticky task queue is 5 seconds.
	// Setting this value also to 5 seconds to match the sticky queue timeout.
	SpeculativeWorkflowTaskScheduleToStartTimeout = 5 * time.Second
)

Variables

View Source
var (
	CategoryTransfer = Category{
						// contains filtered or unexported fields
	}

	CategoryTimer = Category{
					// contains filtered or unexported fields
	}

	CategoryReplication = Category{
						// contains filtered or unexported fields
	}

	CategoryVisibility = Category{
						// contains filtered or unexported fields
	}

	CategoryArchival = Category{
						// contains filtered or unexported fields
	}

	CategoryMemoryTimer = Category{
						// contains filtered or unexported fields
	}
)
View Source
var (
	MinimumKey = NewKey(DefaultFireTime, 0)
	MaximumKey = NewKey(time.Unix(0, math.MaxInt64), math.MaxInt64)
)
View Source
var (
	DefaultFireTime = time.Unix(0, 0).UTC()
)

Functions

func GetShardIDForTask added in v1.23.0

func GetShardIDForTask(task Task, numShards int) int

GetShardIDForTask computes the shardID for a given task using the task's namespace, workflow ID and the number of history shards in the cluster.

func GetTimerTaskEventID added in v1.17.0

func GetTimerTaskEventID(
	timerTask Task,
) int64

func GetTransferTaskEventID added in v1.17.0

func GetTransferTaskEventID(
	transferTask Task,
) int64

func InitializeLogger added in v1.17.0

func InitializeLogger(
	task Task,
	logger log.Logger,
) log.Logger

TODO: deprecate this method, use logger from executable.Logger() instead

func IsNamespacePredicate added in v1.18.0

func IsNamespacePredicate(p Predicate) bool

func IsTypePredicate added in v1.18.0

func IsTypePredicate(p Predicate) bool

func IsUniverisalPredicate added in v1.18.0

func IsUniverisalPredicate(p Predicate) bool

func Tags added in v1.17.0

func Tags(
	task Task,
) []tag.Tag

func ValidateKey added in v1.17.0

func ValidateKey(key Key) error

Types

type ActivityRetryTimerTask

type ActivityRetryTimerTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	EventID             int64
	Version             int64
	Attempt             int32
}

func (*ActivityRetryTimerTask) GetCategory added in v1.16.0

func (r *ActivityRetryTimerTask) GetCategory() Category

func (*ActivityRetryTimerTask) GetKey

func (r *ActivityRetryTimerTask) GetKey() Key

func (*ActivityRetryTimerTask) GetTaskID

func (r *ActivityRetryTimerTask) GetTaskID() int64

func (*ActivityRetryTimerTask) GetType added in v1.16.0

func (*ActivityRetryTimerTask) GetVersion

func (r *ActivityRetryTimerTask) GetVersion() int64

func (*ActivityRetryTimerTask) GetVisibilityTime

func (r *ActivityRetryTimerTask) GetVisibilityTime() time.Time

func (*ActivityRetryTimerTask) SetTaskID

func (r *ActivityRetryTimerTask) SetTaskID(id int64)

func (*ActivityRetryTimerTask) SetVersion

func (r *ActivityRetryTimerTask) SetVersion(version int64)

func (*ActivityRetryTimerTask) SetVisibilityTime

func (r *ActivityRetryTimerTask) SetVisibilityTime(t time.Time)

type ActivityTask

type ActivityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	TaskQueue           string
	ScheduledEventID    int64
	Version             int64
}

func (*ActivityTask) GetCategory added in v1.16.0

func (a *ActivityTask) GetCategory() Category

func (*ActivityTask) GetKey

func (a *ActivityTask) GetKey() Key

func (*ActivityTask) GetTaskID

func (a *ActivityTask) GetTaskID() int64

func (*ActivityTask) GetType added in v1.16.0

func (a *ActivityTask) GetType() enumsspb.TaskType

func (*ActivityTask) GetVersion

func (a *ActivityTask) GetVersion() int64

func (*ActivityTask) GetVisibilityTime

func (a *ActivityTask) GetVisibilityTime() time.Time

func (*ActivityTask) SetTaskID

func (a *ActivityTask) SetTaskID(id int64)

func (*ActivityTask) SetVersion

func (a *ActivityTask) SetVersion(version int64)

func (*ActivityTask) SetVisibilityTime

func (a *ActivityTask) SetVisibilityTime(timestamp time.Time)

type ActivityTimeoutTask

type ActivityTimeoutTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	TimeoutType         enumspb.TimeoutType
	EventID             int64
	Attempt             int32
	Version             int64
}

func (*ActivityTimeoutTask) GetCategory added in v1.16.0

func (a *ActivityTimeoutTask) GetCategory() Category

func (*ActivityTimeoutTask) GetKey

func (a *ActivityTimeoutTask) GetKey() Key

func (*ActivityTimeoutTask) GetTaskID

func (a *ActivityTimeoutTask) GetTaskID() int64

func (*ActivityTimeoutTask) GetType added in v1.16.0

func (a *ActivityTimeoutTask) GetType() enumsspb.TaskType

func (*ActivityTimeoutTask) GetVersion

func (a *ActivityTimeoutTask) GetVersion() int64

func (*ActivityTimeoutTask) GetVisibilityTime

func (a *ActivityTimeoutTask) GetVisibilityTime() time.Time

func (*ActivityTimeoutTask) SetTaskID

func (a *ActivityTimeoutTask) SetTaskID(id int64)

func (*ActivityTimeoutTask) SetVersion

func (a *ActivityTimeoutTask) SetVersion(version int64)

func (*ActivityTimeoutTask) SetVisibilityTime

func (a *ActivityTimeoutTask) SetVisibilityTime(t time.Time)

type ArchiveExecutionTask added in v1.19.0

type ArchiveExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

ArchiveExecutionTask is the task which archives both the history and visibility of a workflow execution and then produces a retention timer task to delete the data.

func (*ArchiveExecutionTask) GetCategory added in v1.19.0

func (a *ArchiveExecutionTask) GetCategory() Category

func (*ArchiveExecutionTask) GetKey added in v1.19.0

func (a *ArchiveExecutionTask) GetKey() Key

func (*ArchiveExecutionTask) GetTaskID added in v1.19.0

func (a *ArchiveExecutionTask) GetTaskID() int64

func (*ArchiveExecutionTask) GetType added in v1.19.0

func (a *ArchiveExecutionTask) GetType() enumsspb.TaskType

func (*ArchiveExecutionTask) GetVersion added in v1.19.0

func (a *ArchiveExecutionTask) GetVersion() int64

func (*ArchiveExecutionTask) GetVisibilityTime added in v1.19.0

func (a *ArchiveExecutionTask) GetVisibilityTime() time.Time

func (*ArchiveExecutionTask) SetTaskID added in v1.19.0

func (a *ArchiveExecutionTask) SetTaskID(id int64)

func (*ArchiveExecutionTask) SetVisibilityTime added in v1.19.0

func (a *ArchiveExecutionTask) SetVisibilityTime(timestamp time.Time)

type CancelExecutionTask

type CancelExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp     time.Time
	TaskID                  int64
	TargetNamespaceID       string
	TargetWorkflowID        string
	TargetRunID             string
	TargetChildWorkflowOnly bool
	InitiatedEventID        int64
	Version                 int64
}

func (*CancelExecutionTask) GetCategory added in v1.16.0

func (u *CancelExecutionTask) GetCategory() Category

func (*CancelExecutionTask) GetKey

func (u *CancelExecutionTask) GetKey() Key

func (*CancelExecutionTask) GetTaskID

func (u *CancelExecutionTask) GetTaskID() int64

func (*CancelExecutionTask) GetType added in v1.16.0

func (u *CancelExecutionTask) GetType() enumsspb.TaskType

func (*CancelExecutionTask) GetVersion

func (u *CancelExecutionTask) GetVersion() int64

func (*CancelExecutionTask) GetVisibilityTime

func (u *CancelExecutionTask) GetVisibilityTime() time.Time

func (*CancelExecutionTask) SetTaskID

func (u *CancelExecutionTask) SetTaskID(id int64)

func (*CancelExecutionTask) SetVersion

func (u *CancelExecutionTask) SetVersion(version int64)

func (*CancelExecutionTask) SetVisibilityTime

func (u *CancelExecutionTask) SetVisibilityTime(timestamp time.Time)

type Category added in v1.16.0

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

func NewCategory added in v1.16.0

func NewCategory(id int, cType CategoryType, name string) Category

func (Category) ID added in v1.16.0

func (c Category) ID() int

func (Category) Name added in v1.16.0

func (c Category) Name() string

func (Category) Type added in v1.16.0

func (c Category) Type() CategoryType

type CategoryType added in v1.16.0

type CategoryType int
const (
	CategoryTypeImmediate CategoryType
	CategoryTypeScheduled
)

func (CategoryType) String added in v1.16.0

func (t CategoryType) String() string

type CloseExecutionTask

type CloseExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	DeleteAfterClose    bool
	DeleteProcessStage  DeleteWorkflowExecutionStage
}

func (*CloseExecutionTask) GetCategory added in v1.16.0

func (a *CloseExecutionTask) GetCategory() Category

func (*CloseExecutionTask) GetKey

func (a *CloseExecutionTask) GetKey() Key

func (*CloseExecutionTask) GetTaskID

func (a *CloseExecutionTask) GetTaskID() int64

func (*CloseExecutionTask) GetType added in v1.16.0

func (a *CloseExecutionTask) GetType() enumsspb.TaskType

func (*CloseExecutionTask) GetVersion

func (a *CloseExecutionTask) GetVersion() int64

func (*CloseExecutionTask) GetVisibilityTime

func (a *CloseExecutionTask) GetVisibilityTime() time.Time

func (*CloseExecutionTask) SetTaskID

func (a *CloseExecutionTask) SetTaskID(id int64)

func (*CloseExecutionTask) SetVersion

func (a *CloseExecutionTask) SetVersion(version int64)

func (*CloseExecutionTask) SetVisibilityTime

func (a *CloseExecutionTask) SetVisibilityTime(timestamp time.Time)

type CloseExecutionVisibilityTask

type CloseExecutionVisibilityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

func (*CloseExecutionVisibilityTask) GetCategory added in v1.16.0

func (t *CloseExecutionVisibilityTask) GetCategory() Category

func (*CloseExecutionVisibilityTask) GetKey

func (t *CloseExecutionVisibilityTask) GetKey() Key

func (*CloseExecutionVisibilityTask) GetTaskID

func (t *CloseExecutionVisibilityTask) GetTaskID() int64

func (*CloseExecutionVisibilityTask) GetType added in v1.16.0

func (*CloseExecutionVisibilityTask) GetVersion

func (t *CloseExecutionVisibilityTask) GetVersion() int64

func (*CloseExecutionVisibilityTask) GetVisibilityTime

func (t *CloseExecutionVisibilityTask) GetVisibilityTime() time.Time

func (*CloseExecutionVisibilityTask) SetTaskID

func (t *CloseExecutionVisibilityTask) SetTaskID(id int64)

func (*CloseExecutionVisibilityTask) SetVersion

func (t *CloseExecutionVisibilityTask) SetVersion(version int64)

func (*CloseExecutionVisibilityTask) SetVisibilityTime

func (t *CloseExecutionVisibilityTask) SetVisibilityTime(timestamp time.Time)

type DeleteExecutionTask added in v1.15.0

type DeleteExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	ProcessStage        DeleteWorkflowExecutionStage
}

func (*DeleteExecutionTask) GetCategory added in v1.16.0

func (a *DeleteExecutionTask) GetCategory() Category

func (*DeleteExecutionTask) GetKey added in v1.15.0

func (a *DeleteExecutionTask) GetKey() Key

func (*DeleteExecutionTask) GetTaskID added in v1.15.0

func (a *DeleteExecutionTask) GetTaskID() int64

func (*DeleteExecutionTask) GetType added in v1.16.0

func (a *DeleteExecutionTask) GetType() enumsspb.TaskType

func (*DeleteExecutionTask) GetVersion added in v1.15.0

func (a *DeleteExecutionTask) GetVersion() int64

func (*DeleteExecutionTask) GetVisibilityTime added in v1.15.0

func (a *DeleteExecutionTask) GetVisibilityTime() time.Time

func (*DeleteExecutionTask) SetTaskID added in v1.15.0

func (a *DeleteExecutionTask) SetTaskID(id int64)

func (*DeleteExecutionTask) SetVersion added in v1.15.0

func (a *DeleteExecutionTask) SetVersion(version int64)

func (*DeleteExecutionTask) SetVisibilityTime added in v1.15.0

func (a *DeleteExecutionTask) SetVisibilityTime(timestamp time.Time)

type DeleteExecutionVisibilityTask

type DeleteExecutionVisibilityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp            time.Time
	TaskID                         int64
	Version                        int64
	CloseExecutionVisibilityTaskID int64
}

func (*DeleteExecutionVisibilityTask) GetCategory added in v1.16.0

func (t *DeleteExecutionVisibilityTask) GetCategory() Category

func (*DeleteExecutionVisibilityTask) GetKey

func (t *DeleteExecutionVisibilityTask) GetKey() Key

func (*DeleteExecutionVisibilityTask) GetTaskID

func (t *DeleteExecutionVisibilityTask) GetTaskID() int64

func (*DeleteExecutionVisibilityTask) GetType added in v1.16.0

func (*DeleteExecutionVisibilityTask) GetVersion

func (t *DeleteExecutionVisibilityTask) GetVersion() int64

func (*DeleteExecutionVisibilityTask) GetVisibilityTime

func (t *DeleteExecutionVisibilityTask) GetVisibilityTime() time.Time

func (*DeleteExecutionVisibilityTask) SetTaskID

func (t *DeleteExecutionVisibilityTask) SetTaskID(id int64)

func (*DeleteExecutionVisibilityTask) SetVersion

func (t *DeleteExecutionVisibilityTask) SetVersion(version int64)

func (*DeleteExecutionVisibilityTask) SetVisibilityTime

func (t *DeleteExecutionVisibilityTask) SetVisibilityTime(timestamp time.Time)

type DeleteHistoryEventTask

type DeleteHistoryEventTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	BranchToken         []byte
	ProcessStage        DeleteWorkflowExecutionStage
}

func (*DeleteHistoryEventTask) GetCategory added in v1.16.0

func (a *DeleteHistoryEventTask) GetCategory() Category

func (*DeleteHistoryEventTask) GetKey

func (a *DeleteHistoryEventTask) GetKey() Key

func (*DeleteHistoryEventTask) GetTaskID

func (a *DeleteHistoryEventTask) GetTaskID() int64

func (*DeleteHistoryEventTask) GetType added in v1.16.0

func (*DeleteHistoryEventTask) GetVersion

func (a *DeleteHistoryEventTask) GetVersion() int64

func (*DeleteHistoryEventTask) GetVisibilityTime

func (a *DeleteHistoryEventTask) GetVisibilityTime() time.Time

func (*DeleteHistoryEventTask) SetTaskID

func (a *DeleteHistoryEventTask) SetTaskID(id int64)

func (*DeleteHistoryEventTask) SetVersion

func (a *DeleteHistoryEventTask) SetVersion(version int64)

func (*DeleteHistoryEventTask) SetVisibilityTime

func (a *DeleteHistoryEventTask) SetVisibilityTime(timestamp time.Time)

type DeleteWorkflowExecutionStage added in v1.19.0

type DeleteWorkflowExecutionStage byte

DeleteWorkflowExecutionStage used by ContextImpl.DeleteWorkflowExecution to indicate progress stage.

const (
	DeleteWorkflowExecutionStageVisibility DeleteWorkflowExecutionStage = 1 << iota
	DeleteWorkflowExecutionStageCurrent
	DeleteWorkflowExecutionStageMutableState
	DeleteWorkflowExecutionStageHistory
)
const (
	DeleteWorkflowExecutionStageNone DeleteWorkflowExecutionStage = 0
)

func (*DeleteWorkflowExecutionStage) IsProcessed added in v1.19.0

func (*DeleteWorkflowExecutionStage) MarkProcessed added in v1.19.0

type DestinationPredicate added in v1.24.0

type DestinationPredicate struct {
	Destinations map[string]struct{}
}

func NewDestinationPredicate added in v1.24.0

func NewDestinationPredicate(
	destinations []string,
) *DestinationPredicate

func (*DestinationPredicate) Equals added in v1.24.0

func (n *DestinationPredicate) Equals(predicate Predicate) bool

func (*DestinationPredicate) Test added in v1.24.0

func (n *DestinationPredicate) Test(task Task) bool

type FakeDestinationTask

type FakeDestinationTask struct {
	Task
	Destination string
}

func (FakeDestinationTask) GetDestination

func (t FakeDestinationTask) GetDestination() string

type FakeTask added in v1.19.0

type FakeTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	Category            Category
}

func (*FakeTask) GetCategory added in v1.19.0

func (f *FakeTask) GetCategory() Category

func (*FakeTask) GetKey added in v1.19.0

func (f *FakeTask) GetKey() Key

func (*FakeTask) GetTaskID added in v1.19.0

func (f *FakeTask) GetTaskID() int64

func (*FakeTask) GetType added in v1.19.0

func (f *FakeTask) GetType() enumsspb.TaskType

func (*FakeTask) GetVersion added in v1.19.0

func (f *FakeTask) GetVersion() int64

func (*FakeTask) GetVisibilityTime added in v1.19.0

func (f *FakeTask) GetVisibilityTime() time.Time

func (*FakeTask) SetTaskID added in v1.19.0

func (f *FakeTask) SetTaskID(id int64)

func (*FakeTask) SetVersion added in v1.19.0

func (f *FakeTask) SetVersion(version int64)

func (*FakeTask) SetVisibilityTime added in v1.19.0

func (f *FakeTask) SetVisibilityTime(t time.Time)

type HasDestination added in v1.24.0

type HasDestination interface {
	GetDestination() string
}

HasDestination must be implemented by all tasks used in multi-destination queues.

type HistoryReplicationTask

type HistoryReplicationTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	FirstEventID        int64
	NextEventID         int64
	Version             int64
	// deprecated
	BranchToken []byte
	// deprecated
	NewRunBranchToken []byte
	NewRunID          string
}

func (*HistoryReplicationTask) GetCategory added in v1.16.0

func (a *HistoryReplicationTask) GetCategory() Category

func (*HistoryReplicationTask) GetKey

func (a *HistoryReplicationTask) GetKey() Key

func (*HistoryReplicationTask) GetTaskID

func (a *HistoryReplicationTask) GetTaskID() int64

func (*HistoryReplicationTask) GetType added in v1.16.0

func (*HistoryReplicationTask) GetVersion

func (a *HistoryReplicationTask) GetVersion() int64

func (*HistoryReplicationTask) GetVisibilityTime

func (a *HistoryReplicationTask) GetVisibilityTime() time.Time

func (*HistoryReplicationTask) SetTaskID

func (a *HistoryReplicationTask) SetTaskID(id int64)

func (*HistoryReplicationTask) SetVersion

func (a *HistoryReplicationTask) SetVersion(version int64)

func (*HistoryReplicationTask) SetVisibilityTime

func (a *HistoryReplicationTask) SetVisibilityTime(timestamp time.Time)

type Key

type Key struct {
	// FireTime is the scheduled time of the task
	FireTime time.Time
	// TaskID is the ID of the task
	TaskID int64
}

func MaxKey added in v1.17.0

func MaxKey(this Key, that Key) Key

func MinKey added in v1.17.0

func MinKey(this Key, that Key) Key

func NewImmediateKey added in v1.17.0

func NewImmediateKey(taskID int64) Key

func NewKey added in v1.17.0

func NewKey(fireTime time.Time, taskID int64) Key

func (Key) CompareTo

func (left Key) CompareTo(right Key) int

func (Key) Next added in v1.17.0

func (k Key) Next() Key

func (Key) Prev added in v1.17.0

func (k Key) Prev() Key

func (Key) Sub added in v1.18.0

func (k Key) Sub(subtrahend Key) Key

type Keys

type Keys []Key

func (Keys) Len

func (s Keys) Len() int

Len implements sort.Interface

func (Keys) Less

func (s Keys) Less(
	this int,
	that int,
) bool

Less implements sort.Interface

func (Keys) Swap

func (s Keys) Swap(
	this int,
	that int,
)

Swap implements sort.Interface.

type MockHasDestination added in v1.24.0

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

MockHasDestination is a mock of HasDestination interface.

func NewMockHasDestination added in v1.24.0

func NewMockHasDestination(ctrl *gomock.Controller) *MockHasDestination

NewMockHasDestination creates a new mock instance.

func (*MockHasDestination) EXPECT added in v1.24.0

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockHasDestination) GetDestination added in v1.24.0

func (m *MockHasDestination) GetDestination() string

GetDestination mocks base method.

type MockHasDestinationMockRecorder added in v1.24.0

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

MockHasDestinationMockRecorder is the mock recorder for MockHasDestination.

func (*MockHasDestinationMockRecorder) GetDestination added in v1.24.0

func (mr *MockHasDestinationMockRecorder) GetDestination() *gomock.Call

GetDestination indicates an expected call of GetDestination.

type MockTask added in v1.17.0

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

MockTask is a mock of Task interface.

func NewMockTask added in v1.17.0

func NewMockTask(ctrl *gomock.Controller) *MockTask

NewMockTask creates a new mock instance.

func (*MockTask) EXPECT added in v1.17.0

func (m *MockTask) EXPECT() *MockTaskMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockTask) GetCategory added in v1.17.0

func (m *MockTask) GetCategory() Category

GetCategory mocks base method.

func (*MockTask) GetKey added in v1.17.0

func (m *MockTask) GetKey() Key

GetKey mocks base method.

func (*MockTask) GetNamespaceID added in v1.17.0

func (m *MockTask) GetNamespaceID() string

GetNamespaceID mocks base method.

func (*MockTask) GetRunID added in v1.17.0

func (m *MockTask) GetRunID() string

GetRunID mocks base method.

func (*MockTask) GetTaskID added in v1.17.0

func (m *MockTask) GetTaskID() int64

GetTaskID mocks base method.

func (*MockTask) GetType added in v1.17.0

func (m *MockTask) GetType() v1.TaskType

GetType mocks base method.

func (*MockTask) GetVersion added in v1.17.0

func (m *MockTask) GetVersion() int64

GetVersion mocks base method.

func (*MockTask) GetVisibilityTime added in v1.17.0

func (m *MockTask) GetVisibilityTime() time.Time

GetVisibilityTime mocks base method.

func (*MockTask) GetWorkflowID added in v1.17.0

func (m *MockTask) GetWorkflowID() string

GetWorkflowID mocks base method.

func (*MockTask) SetTaskID added in v1.17.0

func (m *MockTask) SetTaskID(id int64)

SetTaskID mocks base method.

func (*MockTask) SetVisibilityTime added in v1.17.0

func (m *MockTask) SetVisibilityTime(timestamp time.Time)

SetVisibilityTime mocks base method.

type MockTaskMockRecorder added in v1.17.0

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

MockTaskMockRecorder is the mock recorder for MockTask.

func (*MockTaskMockRecorder) GetCategory added in v1.17.0

func (mr *MockTaskMockRecorder) GetCategory() *gomock.Call

GetCategory indicates an expected call of GetCategory.

func (*MockTaskMockRecorder) GetKey added in v1.17.0

func (mr *MockTaskMockRecorder) GetKey() *gomock.Call

GetKey indicates an expected call of GetKey.

func (*MockTaskMockRecorder) GetNamespaceID added in v1.17.0

func (mr *MockTaskMockRecorder) GetNamespaceID() *gomock.Call

GetNamespaceID indicates an expected call of GetNamespaceID.

func (*MockTaskMockRecorder) GetRunID added in v1.17.0

func (mr *MockTaskMockRecorder) GetRunID() *gomock.Call

GetRunID indicates an expected call of GetRunID.

func (*MockTaskMockRecorder) GetTaskID added in v1.17.0

func (mr *MockTaskMockRecorder) GetTaskID() *gomock.Call

GetTaskID indicates an expected call of GetTaskID.

func (*MockTaskMockRecorder) GetType added in v1.17.0

func (mr *MockTaskMockRecorder) GetType() *gomock.Call

GetType indicates an expected call of GetType.

func (*MockTaskMockRecorder) GetVersion added in v1.17.0

func (mr *MockTaskMockRecorder) GetVersion() *gomock.Call

GetVersion indicates an expected call of GetVersion.

func (*MockTaskMockRecorder) GetVisibilityTime added in v1.17.0

func (mr *MockTaskMockRecorder) GetVisibilityTime() *gomock.Call

GetVisibilityTime indicates an expected call of GetVisibilityTime.

func (*MockTaskMockRecorder) GetWorkflowID added in v1.17.0

func (mr *MockTaskMockRecorder) GetWorkflowID() *gomock.Call

GetWorkflowID indicates an expected call of GetWorkflowID.

func (*MockTaskMockRecorder) SetTaskID added in v1.17.0

func (mr *MockTaskMockRecorder) SetTaskID(id interface{}) *gomock.Call

SetTaskID indicates an expected call of SetTaskID.

func (*MockTaskMockRecorder) SetVisibilityTime added in v1.17.0

func (mr *MockTaskMockRecorder) SetVisibilityTime(timestamp interface{}) *gomock.Call

SetVisibilityTime indicates an expected call of SetVisibilityTime.

type MutableTaskCategoryRegistry added in v1.23.0

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

MutableTaskCategoryRegistry is a TaskCategoryRegistry which also supports the addition of new categories. We separate the two types to prevent the addition of new categories after the initialization phase; only the immutable TaskCategoryRegistry should be available after initialization. This object is not thread-safe, but it is intended to be used with fx, which is single-threaded.

func NewDefaultTaskCategoryRegistry added in v1.23.0

func NewDefaultTaskCategoryRegistry() *MutableTaskCategoryRegistry

NewDefaultTaskCategoryRegistry creates a new MutableTaskCategoryRegistry with the default categories. The "default" categories here are really the unconditional categories: task categories that we always process, independent of any configuration. This type is intended to be used as a singleton, so you should only create a new instance once for each entry point that uses it. Essentially, get it from the dependency graph instead of calling this method, unless you're in a test.

func (*MutableTaskCategoryRegistry) AddCategory added in v1.23.0

func (r *MutableTaskCategoryRegistry) AddCategory(c Category)

AddCategory register a Category with the registry or panics if a Category with the same ID has already been registered.

func (*MutableTaskCategoryRegistry) GetCategories added in v1.23.0

func (r *MutableTaskCategoryRegistry) GetCategories() map[int]Category

GetCategories returns a deep copy of all registered Category objects from the registry.

func (*MutableTaskCategoryRegistry) GetCategoryByID added in v1.23.0

func (r *MutableTaskCategoryRegistry) GetCategoryByID(id int) (Category, bool)

GetCategoryByID returns a registered Category with the same ID from the registry or false if no such Category exists.

type NamespacePredicate added in v1.17.0

type NamespacePredicate struct {
	NamespaceIDs map[string]struct{}
}

func NewNamespacePredicate added in v1.17.0

func NewNamespacePredicate(
	namespaceIDs []string,
) *NamespacePredicate

func (*NamespacePredicate) Equals added in v1.17.0

func (n *NamespacePredicate) Equals(predicate Predicate) bool

func (*NamespacePredicate) Test added in v1.17.0

func (n *NamespacePredicate) Test(task Task) bool

type Predicate added in v1.17.0

type Predicate = predicates.Predicate[Task]

func AndPredicates added in v1.17.3

func AndPredicates(a Predicate, b Predicate) Predicate

func OrPredicates added in v1.17.3

func OrPredicates(a Predicate, b Predicate) Predicate

type ResetWorkflowTask

type ResetWorkflowTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

func (*ResetWorkflowTask) GetCategory added in v1.16.0

func (a *ResetWorkflowTask) GetCategory() Category

func (*ResetWorkflowTask) GetKey

func (a *ResetWorkflowTask) GetKey() Key

func (*ResetWorkflowTask) GetTaskID

func (a *ResetWorkflowTask) GetTaskID() int64

func (*ResetWorkflowTask) GetType added in v1.16.0

func (a *ResetWorkflowTask) GetType() enumsspb.TaskType

func (*ResetWorkflowTask) GetVersion

func (a *ResetWorkflowTask) GetVersion() int64

func (*ResetWorkflowTask) GetVisibilityTime

func (a *ResetWorkflowTask) GetVisibilityTime() time.Time

func (*ResetWorkflowTask) SetTaskID

func (a *ResetWorkflowTask) SetTaskID(id int64)

func (*ResetWorkflowTask) SetVersion

func (a *ResetWorkflowTask) SetVersion(version int64)

func (*ResetWorkflowTask) SetVisibilityTime

func (a *ResetWorkflowTask) SetVisibilityTime(timestamp time.Time)

type SignalExecutionTask

type SignalExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp     time.Time
	TaskID                  int64
	TargetNamespaceID       string
	TargetWorkflowID        string
	TargetRunID             string
	TargetChildWorkflowOnly bool
	InitiatedEventID        int64
	Version                 int64
}

func (*SignalExecutionTask) GetCategory added in v1.16.0

func (u *SignalExecutionTask) GetCategory() Category

func (*SignalExecutionTask) GetKey

func (u *SignalExecutionTask) GetKey() Key

func (*SignalExecutionTask) GetTaskID

func (u *SignalExecutionTask) GetTaskID() int64

func (*SignalExecutionTask) GetType added in v1.16.0

func (u *SignalExecutionTask) GetType() enumsspb.TaskType

func (*SignalExecutionTask) GetVersion

func (u *SignalExecutionTask) GetVersion() int64

func (*SignalExecutionTask) GetVisibilityTime

func (u *SignalExecutionTask) GetVisibilityTime() time.Time

func (*SignalExecutionTask) SetTaskID

func (u *SignalExecutionTask) SetTaskID(id int64)

func (*SignalExecutionTask) SetVersion

func (u *SignalExecutionTask) SetVersion(version int64)

func (*SignalExecutionTask) SetVisibilityTime

func (u *SignalExecutionTask) SetVisibilityTime(timestamp time.Time)

type StartChildExecutionTask

type StartChildExecutionTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	TargetNamespaceID   string
	TargetWorkflowID    string
	InitiatedEventID    int64
	Version             int64
}

func (*StartChildExecutionTask) GetCategory added in v1.16.0

func (u *StartChildExecutionTask) GetCategory() Category

func (*StartChildExecutionTask) GetKey

func (u *StartChildExecutionTask) GetKey() Key

func (*StartChildExecutionTask) GetTaskID

func (u *StartChildExecutionTask) GetTaskID() int64

func (*StartChildExecutionTask) GetType added in v1.16.0

func (*StartChildExecutionTask) GetVersion

func (u *StartChildExecutionTask) GetVersion() int64

func (*StartChildExecutionTask) GetVisibilityTime

func (u *StartChildExecutionTask) GetVisibilityTime() time.Time

func (*StartChildExecutionTask) SetTaskID

func (u *StartChildExecutionTask) SetTaskID(id int64)

func (*StartChildExecutionTask) SetVersion

func (u *StartChildExecutionTask) SetVersion(version int64)

func (*StartChildExecutionTask) SetVisibilityTime

func (u *StartChildExecutionTask) SetVisibilityTime(timestamp time.Time)

type StartExecutionVisibilityTask

type StartExecutionVisibilityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

func (*StartExecutionVisibilityTask) GetCategory added in v1.16.0

func (t *StartExecutionVisibilityTask) GetCategory() Category

func (*StartExecutionVisibilityTask) GetKey

func (t *StartExecutionVisibilityTask) GetKey() Key

func (*StartExecutionVisibilityTask) GetTaskID

func (t *StartExecutionVisibilityTask) GetTaskID() int64

func (*StartExecutionVisibilityTask) GetType added in v1.16.0

func (*StartExecutionVisibilityTask) GetVersion

func (t *StartExecutionVisibilityTask) GetVersion() int64

func (*StartExecutionVisibilityTask) GetVisibilityTime

func (t *StartExecutionVisibilityTask) GetVisibilityTime() time.Time

func (*StartExecutionVisibilityTask) SetTaskID

func (t *StartExecutionVisibilityTask) SetTaskID(id int64)

func (*StartExecutionVisibilityTask) SetVersion

func (t *StartExecutionVisibilityTask) SetVersion(version int64)

func (*StartExecutionVisibilityTask) SetVisibilityTime

func (t *StartExecutionVisibilityTask) SetVisibilityTime(timestamp time.Time)

type SyncActivityTask

type SyncActivityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	ScheduledEventID    int64
}

func (*SyncActivityTask) GetCategory added in v1.16.0

func (a *SyncActivityTask) GetCategory() Category

func (*SyncActivityTask) GetKey

func (a *SyncActivityTask) GetKey() Key

func (*SyncActivityTask) GetTaskID

func (a *SyncActivityTask) GetTaskID() int64

func (*SyncActivityTask) GetType added in v1.16.0

func (a *SyncActivityTask) GetType() enumsspb.TaskType

func (*SyncActivityTask) GetVersion

func (a *SyncActivityTask) GetVersion() int64

func (*SyncActivityTask) GetVisibilityTime

func (a *SyncActivityTask) GetVisibilityTime() time.Time

func (*SyncActivityTask) SetTaskID

func (a *SyncActivityTask) SetTaskID(id int64)

func (*SyncActivityTask) SetVersion

func (a *SyncActivityTask) SetVersion(version int64)

func (*SyncActivityTask) SetVisibilityTime

func (a *SyncActivityTask) SetVisibilityTime(timestamp time.Time)

type SyncWorkflowStateTask added in v1.17.0

type SyncWorkflowStateTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

func (*SyncWorkflowStateTask) GetCategory added in v1.17.0

func (a *SyncWorkflowStateTask) GetCategory() Category

func (*SyncWorkflowStateTask) GetKey added in v1.17.0

func (a *SyncWorkflowStateTask) GetKey() Key

func (*SyncWorkflowStateTask) GetTaskID added in v1.17.0

func (a *SyncWorkflowStateTask) GetTaskID() int64

func (*SyncWorkflowStateTask) GetType added in v1.17.0

func (*SyncWorkflowStateTask) GetVersion added in v1.17.0

func (a *SyncWorkflowStateTask) GetVersion() int64

func (*SyncWorkflowStateTask) GetVisibilityTime added in v1.17.0

func (a *SyncWorkflowStateTask) GetVisibilityTime() time.Time

func (*SyncWorkflowStateTask) SetTaskID added in v1.17.0

func (a *SyncWorkflowStateTask) SetTaskID(id int64)

func (*SyncWorkflowStateTask) SetVersion added in v1.17.0

func (a *SyncWorkflowStateTask) SetVersion(version int64)

func (*SyncWorkflowStateTask) SetVisibilityTime added in v1.17.0

func (a *SyncWorkflowStateTask) SetVisibilityTime(timestamp time.Time)

type Task

type Task interface {
	GetKey() Key
	GetNamespaceID() string
	GetWorkflowID() string
	GetRunID() string
	GetTaskID() int64
	GetVisibilityTime() time.Time
	GetVersion() int64
	GetCategory() Category
	GetType() enumsspb.TaskType

	SetTaskID(id int64)
	SetVisibilityTime(timestamp time.Time)
}

Task is the generic task interface

func NewFakeTask added in v1.16.0

func NewFakeTask(
	workflowKey definition.WorkflowKey,
	category Category,
	visibilityTimestamp time.Time,
) Task

type TaskCategoryRegistry added in v1.23.0

type TaskCategoryRegistry interface {
	GetCategoryByID(id int) (Category, bool)
	GetCategories() map[int]Category
}

TaskCategoryRegistry keeps track of all registered Category objects.

type TypePredicate added in v1.17.0

type TypePredicate struct {
	Types map[enumsspb.TaskType]struct{}
}

func NewTypePredicate added in v1.17.0

func NewTypePredicate(
	types []enumsspb.TaskType,
) *TypePredicate

func (*TypePredicate) Equals added in v1.17.0

func (t *TypePredicate) Equals(predicate Predicate) bool

func (*TypePredicate) Test added in v1.17.0

func (t *TypePredicate) Test(task Task) bool

type UpsertExecutionVisibilityTask

type UpsertExecutionVisibilityTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	// this version is not used by task processing for validation,
	// instead, the version is used by Elasticsearch
	Version int64
}

func (*UpsertExecutionVisibilityTask) GetCategory added in v1.16.0

func (t *UpsertExecutionVisibilityTask) GetCategory() Category

func (*UpsertExecutionVisibilityTask) GetKey

func (t *UpsertExecutionVisibilityTask) GetKey() Key

func (*UpsertExecutionVisibilityTask) GetTaskID

func (t *UpsertExecutionVisibilityTask) GetTaskID() int64

func (*UpsertExecutionVisibilityTask) GetType added in v1.16.0

func (*UpsertExecutionVisibilityTask) GetVersion

func (t *UpsertExecutionVisibilityTask) GetVersion() int64

func (*UpsertExecutionVisibilityTask) GetVisibilityTime

func (t *UpsertExecutionVisibilityTask) GetVisibilityTime() time.Time

func (*UpsertExecutionVisibilityTask) SetTaskID

func (t *UpsertExecutionVisibilityTask) SetTaskID(id int64)

func (*UpsertExecutionVisibilityTask) SetVersion

func (t *UpsertExecutionVisibilityTask) SetVersion(version int64)

func (*UpsertExecutionVisibilityTask) SetVisibilityTime

func (t *UpsertExecutionVisibilityTask) SetVisibilityTime(timestamp time.Time)

type UserTimerTask

type UserTimerTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	EventID             int64
	Version             int64
}

func (*UserTimerTask) GetCategory added in v1.16.0

func (u *UserTimerTask) GetCategory() Category

func (*UserTimerTask) GetKey

func (u *UserTimerTask) GetKey() Key

func (*UserTimerTask) GetTaskID

func (u *UserTimerTask) GetTaskID() int64

func (*UserTimerTask) GetType added in v1.16.0

func (u *UserTimerTask) GetType() enumsspb.TaskType

func (*UserTimerTask) GetVersion

func (u *UserTimerTask) GetVersion() int64

func (*UserTimerTask) GetVisibilityTime

func (u *UserTimerTask) GetVisibilityTime() time.Time

func (*UserTimerTask) SetTaskID

func (u *UserTimerTask) SetTaskID(id int64)

func (*UserTimerTask) SetVersion

func (u *UserTimerTask) SetVersion(version int64)

func (*UserTimerTask) SetVisibilityTime

func (u *UserTimerTask) SetVisibilityTime(t time.Time)

type WorkflowBackoffTimerTask

type WorkflowBackoffTimerTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
	WorkflowBackoffType enumsspb.WorkflowBackoffType
}

func (*WorkflowBackoffTimerTask) GetCategory added in v1.16.0

func (r *WorkflowBackoffTimerTask) GetCategory() Category

func (*WorkflowBackoffTimerTask) GetKey

func (r *WorkflowBackoffTimerTask) GetKey() Key

func (*WorkflowBackoffTimerTask) GetTaskID

func (r *WorkflowBackoffTimerTask) GetTaskID() int64

func (*WorkflowBackoffTimerTask) GetType added in v1.16.0

func (*WorkflowBackoffTimerTask) GetVersion

func (r *WorkflowBackoffTimerTask) GetVersion() int64

func (*WorkflowBackoffTimerTask) GetVisibilityTime

func (r *WorkflowBackoffTimerTask) GetVisibilityTime() time.Time

func (*WorkflowBackoffTimerTask) SetTaskID

func (r *WorkflowBackoffTimerTask) SetTaskID(id int64)

func (*WorkflowBackoffTimerTask) SetVersion

func (r *WorkflowBackoffTimerTask) SetVersion(version int64)

func (*WorkflowBackoffTimerTask) SetVisibilityTime

func (r *WorkflowBackoffTimerTask) SetVisibilityTime(t time.Time)

type WorkflowTask

type WorkflowTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	TaskQueue           string
	ScheduledEventID    int64
	Version             int64
}

func (*WorkflowTask) GetCategory added in v1.16.0

func (d *WorkflowTask) GetCategory() Category

func (*WorkflowTask) GetKey

func (d *WorkflowTask) GetKey() Key

func (*WorkflowTask) GetTaskID

func (d *WorkflowTask) GetTaskID() int64

func (*WorkflowTask) GetType added in v1.16.0

func (d *WorkflowTask) GetType() enumsspb.TaskType

func (*WorkflowTask) GetVersion

func (d *WorkflowTask) GetVersion() int64

func (*WorkflowTask) GetVisibilityTime

func (d *WorkflowTask) GetVisibilityTime() time.Time

func (*WorkflowTask) SetTaskID

func (d *WorkflowTask) SetTaskID(id int64)

func (*WorkflowTask) SetVersion

func (d *WorkflowTask) SetVersion(version int64)

func (*WorkflowTask) SetVisibilityTime

func (d *WorkflowTask) SetVisibilityTime(timestamp time.Time)

type WorkflowTaskTimeoutTask

type WorkflowTaskTimeoutTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	EventID             int64
	ScheduleAttempt     int32
	TimeoutType         enumspb.TimeoutType
	Version             int64
	// contains filtered or unexported fields
}

func (*WorkflowTaskTimeoutTask) Cancel added in v1.21.0

func (d *WorkflowTaskTimeoutTask) Cancel()

Cancel and State are used by in-memory WorkflowTaskTimeoutTask (for speculative WT) only. TODO (alex): They need to be moved to speculativeWorkflowTaskTimeoutExecutable and workflowTaskStateMachine should somehow signal that executable directly. Major refactoring needs to be done to achieve that.

func (*WorkflowTaskTimeoutTask) GetCategory added in v1.16.0

func (d *WorkflowTaskTimeoutTask) GetCategory() Category

func (*WorkflowTaskTimeoutTask) GetKey

func (d *WorkflowTaskTimeoutTask) GetKey() Key

func (*WorkflowTaskTimeoutTask) GetTaskID

func (d *WorkflowTaskTimeoutTask) GetTaskID() int64

func (*WorkflowTaskTimeoutTask) GetType added in v1.16.0

func (*WorkflowTaskTimeoutTask) GetVersion

func (d *WorkflowTaskTimeoutTask) GetVersion() int64

func (*WorkflowTaskTimeoutTask) GetVisibilityTime

func (d *WorkflowTaskTimeoutTask) GetVisibilityTime() time.Time

func (*WorkflowTaskTimeoutTask) SetTaskID

func (d *WorkflowTaskTimeoutTask) SetTaskID(id int64)

func (*WorkflowTaskTimeoutTask) SetVersion

func (d *WorkflowTaskTimeoutTask) SetVersion(version int64)

func (*WorkflowTaskTimeoutTask) SetVisibilityTime

func (d *WorkflowTaskTimeoutTask) SetVisibilityTime(t time.Time)

func (*WorkflowTaskTimeoutTask) State added in v1.21.0

type WorkflowTimeoutTask

type WorkflowTimeoutTask struct {
	definition.WorkflowKey
	VisibilityTimestamp time.Time
	TaskID              int64
	Version             int64
}

func (*WorkflowTimeoutTask) GetCategory added in v1.16.0

func (u *WorkflowTimeoutTask) GetCategory() Category

func (*WorkflowTimeoutTask) GetKey

func (u *WorkflowTimeoutTask) GetKey() Key

func (*WorkflowTimeoutTask) GetTaskID

func (u *WorkflowTimeoutTask) GetTaskID() int64

func (*WorkflowTimeoutTask) GetType added in v1.16.0

func (u *WorkflowTimeoutTask) GetType() enumsspb.TaskType

func (*WorkflowTimeoutTask) GetVersion

func (u *WorkflowTimeoutTask) GetVersion() int64

func (*WorkflowTimeoutTask) GetVisibilityTime

func (u *WorkflowTimeoutTask) GetVisibilityTime() time.Time

func (*WorkflowTimeoutTask) SetTaskID

func (u *WorkflowTimeoutTask) SetTaskID(id int64)

func (*WorkflowTimeoutTask) SetVersion

func (u *WorkflowTimeoutTask) SetVersion(version int64)

func (*WorkflowTimeoutTask) SetVisibilityTime

func (u *WorkflowTimeoutTask) SetVisibilityTime(t time.Time)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL