messages

package
v1.1.2139 Latest Latest
Warning

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

 Go to latest Published: Feb 13, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// API is the API subject prefix.
	API = "WORKFLOW.Api."
	// APIStoreWorkflow is the store Workflow API subject.
	APIStoreWorkflow = API + "StoreWorkflow"
	// APILaunchProcess is the launch process API subject.
	APILaunchProcess = API + "LaunchProcess"
	// APIListWorkflows is the list workflows API subject.
	APIListWorkflows = API + "ListWorkflows"
	// APIEnsureTaskSubject is the ensure task subject API subject.
	APIEnsureTaskSubject = API + "EnsureTaskSubject"
	// APIListExecution is the list workflow instances API subject.
	APIListExecution = API + "ListExecution"
	// APIListExecutionProcesses is the get processes of a running workflow instance API subject.
	APIListExecutionProcesses = API + "ListExecutionProcesses"
	// APICancelExecution is the cancel an execution API subject.
	APICancelExecution = API + "CancelExecution"
	// APISendMessage is the send workflow message API subject.
	APISendMessage = API + "SendMessage"
	// APICancelProcessInstance is the cancel process instance API message subject.
	APICancelProcessInstance = API + "CancelProcessInstance"
	// APICompleteManualTask is the complete manual task API subject.
	APICompleteManualTask = API + "CompleteManualTask"
	// APICompleteServiceTask is the complete service task API subject.
	APICompleteServiceTask = API + "CompleteServiceTask"
	// APICompleteUserTask is the complete user task API subject.
	APICompleteUserTask = API + "CompleteUserTask"
	// APICompleteSendMessageTask is the complete send message task API subject.
	APICompleteSendMessageTask = API + "CompleteSendMessageTask"
	// APIDeprecateServiceTask is the deprecate service task API subject.
	APIDeprecateServiceTask = API + "DeprecateServiceTask"
	// APIListExecutableProcess is the list executable process API subject.
	APIListExecutableProcess = API + "APIListExecutableProcess"
	// APIListUserTasks is the list user tasks API subject.
	APIListUserTasks = API + "ListUserTasks"
	// APIOpenUserTask is the endpoint for locking a user task and retrieving its specification and state.
	APIOpenUserTask = API + "OpenUserTask"
	// APIGetUserTask is the get user task API subject.
	APIGetUserTask = API + "GetUserTask"
	// APIGetTaskSpecVersions is the get task versions API subject.
	APIGetTaskSpecVersions = API + "GetTaskSpecVersions"
	// APIHandleWorkflowError is the handle workflow error API subject.
	APIHandleWorkflowError = API + "HandleWorkflowError"
	// APIHandleWorkflowFatalError is the handle workflow fatal error API subject.
	APIHandleWorkflowFatalError = API + "HandleWorkflowFatalError"
	// APIRegisterTask registers a task with SHAR and returns the id.  If the task already exists then the ID is returned of the existing task.
	APIRegisterTask = API + "RegisterTask"
	// APIGetProcessInstanceStatus is the get process instance status API subject.
	APIGetProcessInstanceStatus = API + "GetProcessInstanceStatus"
	// APIGetTaskSpec is the get task spec API message subject.
	APIGetTaskSpec = API + "GetTaskSpec"
	// APIGetWorkflowVersions is the get workflow versions API message subject.
	APIGetWorkflowVersions = API + "StreamWorkflowVersions"
	// APIGetWorkflow is the get workflow API message subject.
	APIGetWorkflow = API + "GetWorkflow"
	// APIGetProcessHistory is the get process history API message subject.
	APIGetProcessHistory = API + "GetProcessHistory"
	// APIGetProcessInstanceHeaders is the get process instance headers API message subject.
	APIGetProcessInstanceHeaders = API + "GetProcessInstanceHeaders"
	// APIDisableWorkflow is the disable workflow API message subject.
	APIDisableWorkflow = API + "APIDisableWorkflow"
	// APIEnableWorkflow is the enable workflow API message subject.
	APIEnableWorkflow = API + "APIEnableWorkflow"
	// APIPauseServiceTask is the pause service task API message subject.
	APIPauseServiceTask = API + "APIPauseServiceTask"
	// APIResumeServiceTask is the resume service task API message subject.
	APIResumeServiceTask = API + "APIResumeServiceTask"
	// APIGetVersionInfo is the get server version information API message subject.
	APIGetVersionInfo = API + "GetVersionInfo"
	// APIGetTaskSpecUsage is the get task spec usage API message subject.
	APIGetTaskSpecUsage = API + "GetTaskSpecUsage"
	// APIListTaskSpecUIDs is the list task spec UIDs API message subject.
	APIListTaskSpecUIDs = API + "ListTaskSpecUIDs"
	//APIGetFatalErrors gets fatal errors given a key prefix to search against
	APIGetFatalErrors = API + "GetFatalErrors"
	// APIHeartbeat // is the heartbeat API message subject.
	APIHeartbeat = API + "Heartbeat"
	// APILog // is the client logging message subject.
	APILog = API + "Log"
	// APIListNamespaces is the list namespaces API message subject.
	APIListNamespaces = API + "ListNamespaces"
	// APIPruneWorkflowVersions is the prune workflow versions API message subject.
	APIPruneWorkflowVersions = API + "PruneWorkflowVersions"
	// APIGetJob is the get job API subject.
	APIGetJob = API + "GetJob"
	// APIResolveWorkflow is the resolve workflow API subject.
	APIResolveWorkflow = API + "ResolveWorkflow"
	// APIGetCompensationInputVariables is the get compensation input variables message subject.
	APIGetCompensationInputVariables = API + "GetCompensationInputVariables"
	// APIGetCompensationOutputVariables is the get compensation output variables message subject.
	APIGetCompensationOutputVariables = API + "GetCompensationOutputVariables"
	// APIRetry attempts to execute a previously failed activity again
	APIRetry = API + "Retry"
	// ApiSaveUserTask represents the constant for saving user task state.
	ApiSaveUserTask = API + "SaveUserTask"
)
View Source 
const (
	// WorkflowTelemetryClientCount is the message subject for workflow client count telemetry.
	WorkflowTelemetryClientCount = "WORKFLOW_TELEMETRY.Client.Count"
	// WorkflowTelemetryLog is the message subject for telemetry logging.
	WorkflowTelemetryLog = "WORKFLOW_TELEMETRY.Log"
)
View Source 
const (
	// StateExecutionComplete is the execution complete state
	StateExecutionComplete = ".State.Execution.Complete"
	// StateProcessExecute is the process execute state
	StateProcessExecute = ".State.Process.Execute"
	// StateProcessAbort is the process abort state
	StateProcessAbort = ".State.Process.Abort"
	// StateProcessComplete is the process complete state
	StateProcessComplete = ".State.Process.Complete"
	// StateProcessTerminated is the process terminated state
	StateProcessTerminated = ".State.Process.Terminated"
	//StateTraversalExecute  is the traversal execute state
	StateTraversalExecute = ".State.Traversal.Execute"
	// StateTraversalComplete is the traversal complete state
	StateTraversalComplete = ".State.Traversal.Complete"
	// StateActivityExecute is the activity execute state
	StateActivityExecute = ".State.Activity.Execute"
	// StateActivityComplete is the activity complete state
	StateActivityComplete = ".State.Activity.Complete"
	// StateActivityAbort is the activity abort state
	StateActivityAbort = ".State.Activity.Abort"
	// StateExecutionExecute is the execution execute state
	StateExecutionExecute = ".State.Execution.Execute"
	// StateExecutionAbort is the execute abort state
	StateExecutionAbort = ".State.Execution.Abort"
	//StateJobExecute is the job execute state
	StateJobExecute = ".State.Job.Execute."
	// StateJobExecuteServiceTask is the execute service task state
	StateJobExecuteServiceTask = ".State.Job.Execute.ServiceTask"
	// StateJobAbortServiceTask is the abort service task state
	StateJobAbortServiceTask = ".State.Job.Abort.ServiceTask"
	// StateJobCompleteServiceTask is the complete service task state
	StateJobCompleteServiceTask = ".State.Job.Complete.ServiceTask"
	// StateJobAbortGateway is the abort gateway state
	StateJobAbortGateway = ".State.Job.Abort.Gateway"
	// StateJobAwaitGateway is the await gateway state
	StateJobAwaitGateway = ".State.Job.Await.Gateway"
	// StateJobComplete is the complete job state
	StateJobComplete = ".State.Job.Complete."
	// StateJobExecuteUserTask is the execute user task state
	StateJobExecuteUserTask = ".State.Job.Execute.UserTask"
	// StateJobCompleteUserTask is the complete user task state
	StateJobCompleteUserTask = ".State.Job.Complete.UserTask"
	// StateJobExecuteManualTask is the execute manual task state
	StateJobExecuteManualTask = ".State.Job.Execute.ManualTask"
	// StateJobCompleteManualTask is the complete manual task state
	StateJobCompleteManualTask = ".State.Job.Complete.ManualTask"
	// StateJobExecuteSendMessage is the execute send message state
	StateJobExecuteSendMessage = ".State.Job.Execute.SendMessage"
	// StateJobCompleteSendMessage is the complete send message state
	StateJobCompleteSendMessage = ".State.Job.Complete.SendMessage"
	// StateLog is the log
	StateLog = ".State.Log."
)
View Source 
const (
	// WorkFlowJobAbortAll is the wildcard state message subject for all job abort messages.
	WorkFlowJobAbortAll = streamNS + ".State.Job.Abort.*"
	// WorkFlowJobCompleteAll is the wildcard state message subject for all job completion messages.
	WorkFlowJobCompleteAll = streamNS + "" + StateJobComplete + "*"
	// WorkflowActivityAbort is the state message subject for aborting an activity.
	WorkflowActivityAbort = streamNS + "" + StateActivityAbort
	// WorkflowActivityAll is the wildcard state message subject for all activity messages.
	WorkflowActivityAll = streamNS + ".State.Activity.>"
	// WorkflowActivityComplete is the state message subject for completing an activity.
	WorkflowActivityComplete = streamNS + "" + StateActivityComplete
	// WorkflowActivityExecute is the state message subject for executing an activity.
	WorkflowActivityExecute = streamNS + "" + StateActivityExecute
	// WorkflowCommands is the wildcard state message subject for all workflow commands.
	WorkflowCommands = streamNS + ".Command.>"
	// WorkflowElementTimedExecute is the state message subject for a timed element execute operation.
	WorkflowElementTimedExecute = streamNS + ".Timers.ElementExecute"
	// WorkflowGeneralAbortAll is the wildcard state message subject for all abort messages/.
	WorkflowGeneralAbortAll = streamNS + ".State.*.Abort"
	// WorkflowExecutionAbort is the state message subject for an execution instace being aborted.
	WorkflowExecutionAbort = streamNS + "" + StateExecutionAbort
	// WorkflowExecutionAll is the wildcard state message subject for all execution state messages.
	WorkflowExecutionAll = streamNS + ".State.Execution.>"
	// WorkflowExecutionComplete is the state message subject for completing an execution instance.
	WorkflowExecutionComplete = streamNS + "" + StateExecutionComplete
	// WorkflowExecutionExecute is the state message subject for executing an execution instance.
	WorkflowExecutionExecute = streamNS + "" + StateExecutionExecute
	// WorkflowExecutionTerminated is the state message subject for an execution instance terminating.
	WorkflowExecutionTerminated = streamNS + ".State.Execution.Terminated"
	// WorkflowJobAwaitMessageExecute is the state message subject for awaiting a message.
	WorkflowJobAwaitMessageExecute = streamNS + "" + StateJobExecute + "AwaitMessage"
	// WorkflowJobAwaitMessageComplete is the state message subject for completing awaiting a message.
	WorkflowJobAwaitMessageComplete = streamNS + ".State.Job.Complete.AwaitMessage"
	// WorkflowJobAwaitMessageAbort is the state message subject for aborting awaiting a message.
	WorkflowJobAwaitMessageAbort = streamNS + ".State.Job.Abort.AwaitMessage"
	// WorkflowJobLaunchComplete is the state message subject for completing a launch subworkflow task.
	WorkflowJobLaunchComplete = streamNS + ".State.Job.Complete.Launch"
	// WorkflowJobLaunchExecute is the state message subject for executing a launch subworkflow task.
	WorkflowJobLaunchExecute = streamNS + "" + StateJobExecute + "Launch"
	// WorkflowJobManualTaskAbort is the state message subject for sborting a manual task.
	WorkflowJobManualTaskAbort = streamNS + ".State.Job.Abort.ManualTask"
	// WorkflowJobManualTaskComplete is the state message subject for completing a manual task.
	WorkflowJobManualTaskComplete = streamNS + "" + StateJobCompleteManualTask
	// WorkflowJobManualTaskExecute is the state message subject for executing a manual task.
	WorkflowJobManualTaskExecute = streamNS + "" + StateJobExecute + "ManualTask"
	// WorkflowJobSendMessageComplete is the state message subject for completing a send message task.
	WorkflowJobSendMessageComplete = streamNS + "" + StateJobCompleteSendMessage
	// WorkflowJobSendMessageExecute is the state message subject for executing a send workfloe message task.
	WorkflowJobSendMessageExecute = streamNS + "" + StateJobExecute + "SendMessage.*"
	// WorkflowJobSendMessageExecuteWild is the wildcard state message subject for executing a send workfloe message task.
	WorkflowJobSendMessageExecuteWild = streamNS + "" + StateJobExecute + "SendMessage.>"
	// WorkflowJobServiceTaskAbort is the state message subject for aborting an in progress service task.
	WorkflowJobServiceTaskAbort = streamNS + "" + StateJobAbortServiceTask
	// WorkflowJobServiceTaskComplete is the state message subject for a completed service task,
	WorkflowJobServiceTaskComplete = streamNS + "" + StateJobCompleteServiceTask
	// WorkflowJobServiceTaskExecute is the raw state message subject for executing a service task.  An identifier is added to the end to route messages to the clients.
	WorkflowJobServiceTaskExecute = streamNS + "" + StateJobExecute + "ServiceTask"
	// WorkflowJobServiceTaskExecuteWild is the wildcard state message subject for all execute service task messages.
	WorkflowJobServiceTaskExecuteWild = streamNS + "" + StateJobExecute + "ServiceTask.>"
	// WorkflowJobServiceTaskSetExecuteWild is the state message subject for service tasks that are a part of a service task set
	WorkflowJobServiceTaskSetExecuteWild = streamNS + "" + StateJobExecute + "Set.%s.ServiceTask.%s.%s"
	// WorkflowJobTimerTaskComplete is the state message subject for completing a timed task.
	WorkflowJobTimerTaskComplete = streamNS + ".State.Job.Complete.Timer"
	// WorkflowJobTimerTaskExecute is the state message subject for executing a timed task.
	WorkflowJobTimerTaskExecute = streamNS + "" + StateJobExecute + "Timer"
	// WorkflowJobUserTaskAbort is the state message subject for aborting a user task.
	WorkflowJobUserTaskAbort = streamNS + ".State.Job.Abort.UserTask"
	// WorkflowJobUserTaskComplete is the state message subject for completing a user task.
	WorkflowJobUserTaskComplete = streamNS + "" + StateJobCompleteUserTask
	// WorkflowJobUserTaskExecute is the state message subject for executing a user task.
	WorkflowJobUserTaskExecute = streamNS + "" + StateJobExecute + "UserTask"
	// WorkflowJobGatewayTaskComplete is the state message subject for completing a gateway task.
	WorkflowJobGatewayTaskComplete = streamNS + ".State.Job.Complete.Gateway"
	// WorkflowJobGatewayTaskExecute is the state message subject for executing a gateway task.
	WorkflowJobGatewayTaskExecute = streamNS + "" + StateJobExecute + "Gateway"
	// WorkflowJobGatewayTaskActivate is the state message subject for activating a gateway task for creation or re-entry.
	WorkflowJobGatewayTaskActivate = streamNS + ".State.Job.Activate.Gateway"
	// WorkflowJobGatewayTaskReEnter is the state message subject for re entering an existing gateway task.
	WorkflowJobGatewayTaskReEnter = streamNS + ".State.Job.ReEnter.Gateway"
	// WorkflowJobGatewayTaskAbort is the state message subject for aborting a gateway task.
	WorkflowJobGatewayTaskAbort = streamNS + "" + StateJobAbortGateway
	// WorkflowJobGatewayTaskAwait is the state message subject for waiting for all branches of a convergent gateway task.
	WorkflowJobGatewayTaskAwait = streamNS + "" + StateJobAwaitGateway
	//WorkflowActivityRetry is the state message to attempt retry of a prior failed activity (initially a servicetask/job)
	WorkflowActivityRetry = streamNS + ".State.Activity.Retry"
	// WorkflowLog is the state message subject for logging messages to a workflow activity.
	WorkflowLog = streamNS + "" + StateLog
	// WorkflowLogAll is the wildcard state message subject for all logging messages.
	WorkflowLogAll = streamNS + "" + StateLog + ".*"
	// WorkflowMessage is the state message subject for all workflow messages.
	WorkflowMessage = streamNS + ".Message"
	// WorkflowProcessComplete is the state message subject for completing a workfloe process.
	WorkflowProcessComplete = streamNS + "" + StateProcessComplete
	// WorkflowProcessExecute is the state message subject for executing a workflow process.
	WorkflowProcessExecute = streamNS + "" + StateProcessExecute
	// WorkflowProcessAbort is the state message subject for aborting a workflow process.
	WorkflowProcessAbort = streamNS + "" + StateProcessAbort
	// WorkflowProcessTerminated is the state message subject for a workflow process terminating.
	WorkflowProcessTerminated = streamNS + "" + StateProcessTerminated
	// WorkflowProcessCompensate is the state message subject for a workflow compensation event.
	WorkflowProcessCompensate = streamNS + ".State.Process.Compensate"
	// WorkflowStateAll is the wildcard subject for catching all state messages.
	WorkflowStateAll = streamNS + ".State.>"
	// WorkflowTraversalComplete is the state message subject for completing a traversal.
	WorkflowTraversalComplete = streamNS + "" + StateTraversalComplete
	// WorkflowTraversalExecute is the state message subject for executing a new traversal.
	WorkflowTraversalExecute = streamNS + "" + StateTraversalExecute
)
View Source 
const (
	// WorkflowSystemTaskCreate is the task created broadcast message.
	WorkflowSystemTaskCreate = streamNS + ".System.Task.Create"
	// WorkflowSystemTaskUpdate is the task updated broadcast message.
	WorkflowSystemTaskUpdate = streamNS + ".System.Task.Update"
	// WorkflowSystemTaskPause is the task paused broadcast message.
	WorkflowSystemTaskPause = streamNS + ".System.Task.Pause"
	// WorkflowSystemTaskResume is the task resumed broadcast message.
	WorkflowSystemTaskResume = streamNS + ".System.Task.Resume"
	// WorkflowSystemProcessCreate is the process Create broadcast message.
	WorkflowSystemProcessCreate = streamNS + ".System.ProcessInstance.Create"
	// WorkflowSystemProcessPause is the process paused broadcast message.
	WorkflowSystemProcessPause = streamNS + ".System.Process.Pause"
	// WorkflowSystemProcessError is the process error broadcast message.
	WorkflowSystemProcessError = streamNS + ".System.Process.Error"
	// WorkflowSystemWorkflowDisableLaunchAttempted is the disabled Workflow launch attempted broadcast message.
	WorkflowSystemWorkflowDisableLaunchAttempted = streamNS + ".System.Workflow.DisableLaunchAttempted"
	// WorkflowSystemHistoryArchive is the archive message for history items.
	WorkflowSystemHistoryArchive = streamNS + ".System.History.Archive"
	// WorkflowSystemProcessFatalError is the process fatal error broadcast message.
	WorkflowSystemProcessFatalError = streamNS + ".System.Process.FatalError"
	// WorkflowSystemDeleteWorkflowVersions is the delete workflow versions broadcast message.
	WorkflowSystemDeleteWorkflowVersions = streamNS + ".System.Delete.WorkflowVersions"
)
View Source 
const (
	// WorkflowTelemetryTimer is the message subject for triggering telemetry messages from the server.
	WorkflowTelemetryTimer = "WORKFLOW.Message.Telemetry"
)
View Source 
const (
	// WorkflowTimedExecute is the state message subject for timed workflow execute operation.
	WorkflowTimedExecute = streamNS + ".Timers.WorkflowExecute"
)

Variables

View Source 
var (
	// KvJob is the name of the key value store that holds workflow jobs.
	KvJob = "WORKFLOW_JOB"
	// KvVersion is the name of the key value store that holds an ordered list of workflow version IDs for a given workflow
	KvVersion = "WORKFLOW_VERSION"
	// KvDefinition is the name of the key value store that holds the state machine definition for workflows
	KvDefinition = "WORKFLOW_DEF"
	// KvTelemetry is the name of the key value store that holds open workflow telemetry spans until they are completed.
	KvTelemetry = "WORKFLOW_TELEM"
	// KvInstance is the name of the key value store that holds workflow instance information.
	KvInstance = "WORKFLOW_INSTANCE"
	// KvExecution is the name of the key value store that holds execution information.
	KvExecution = "WORKFLOW_EXECUTION"
	// KvUserTask is the name of the key value store that holds active user tasks.
	KvUserTask = "WORKFLOW_USERTASK"
	// KvOwnerName is the name of the key value store that holds owner names for owner IDs
	KvOwnerName = "WORKFLOW_OWNERNAME"
	// KvOwnerID is the name of the key value store that holds owner IDs for owner names.
	KvOwnerID = "WORKFLOW_OWNERID"
	// KvClientTaskID is the name of the key value store that holds the unique ID used by clients to subscribe to service task messages.
	KvClientTaskID = "WORKFLOW_CLIENTTASK"
	// KvProcessInstance is the name of the key value store holding process instances.
	KvProcessInstance = "WORKFLOW_PROCESS"
	// KvGateway is the name of the key value store holding gateway instances.
	KvGateway = "WORKFLOW_GATEWAY"
	// KvLock is the name of the key value store holding locks.
	KvLock = "WORKFLOW_GENLCK"
	// KvMessageTypes is the name of the key value store containing known message types.
	KvMessageTypes = "WORKFLOW_MSGTYPES"
	// KvTaskSpecVersions is the name of the key value store holding task specification versions.
	KvTaskSpecVersions = "WORKFLOW_TSPECVER"
	// KvTaskSpec is the name of the key value store holding task specification.
	KvTaskSpec = "WORKFLOW_TSKSPEC"
	// KvProcess is the name of the key value store mapping process names to workflow names.
	KvProcess = "WORKFLOW_PROCESS_MAPPING"
	// KvMessages is the name of the key value store containing messages.
	KvMessages = "WORKFLOW_MESSAGES"
	// KvClients is the name of the key value store containing connected clients.
	KvClients = "WORKFLOW_CLIENTS"
	// KvFatalError is the name of the key value store containing fatal errs.
	KvFatalError = "WORKFLOW_FATAL_ERROR"
	// KvUserTaskState represents the state of a user task within a workflow.
	KvUserTaskState = "WORKFLOW_TASK_STATE"
	// KvWorkflowHistory is the key value containing history
	KvWorkflowHistory = "WORKFLOW_HISTORY"
	// KvDepends is the key value containing workflow dependencies
	KvDepends = "WORKFLOW_DEPENDS"
	// KvLiveSharServerInstances is the key value containing current, live shar server instances
	KvLiveSharServerInstances = "LIVE_SHAR_SERVER_INSTANCES"
)
View Source 
var LogLevels = []WorkflowLogLevel{
	LogFatal,
	LogError,
	LogWarn,
	LogInfo,
	LogDebug,
}

LogLevels provides a way of using an index to select a log level.

Functions

This section is empty.

Types

type WorkflowLogLevel added in v1.0.271 

type WorkflowLogLevel string

WorkflowLogLevel represents a subject suffix for logging levels 

const (
	// LogFatal is the suffix for a fatal error.
	LogFatal WorkflowLogLevel = ".Fatal"
	// LogError is the suffix for an error.
	LogError WorkflowLogLevel = ".Error"
	// LogWarn is the suffix for a warning.
	LogWarn WorkflowLogLevel = ".Warning"
	// LogInfo is the suffix for an information message.
	LogInfo WorkflowLogLevel = ".Info"
	// LogDebug is the suffix for a debug message.
	LogDebug WorkflowLogLevel = ".Debug"
)

Source Files

View all Source files

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.