package temporal.api.sdk.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Internal structure used to create worker stack traces with references to code.

• optional StackTraceSDKInfo sdk = 1

  Information pertaining to the SDK that the trace has been captured from.

• map<string, StackTraceFileSlice> sources = 2

  Mapping of file path to file contents.

• repeated StackTrace stacks = 3

  Collection of stacks captured.

Used in: command.v1.Command, history.v1.HistoryEvent

• oneof variant

  What this Marker represents. The variant determines whether the Marker was created explicitly by user code (label) or implicitly by the SDK on inbound signals/events (inbound_event) or update handlers (inbound_update).

  • EventGroupMarker.Label label = 1

  • EventGroupMarker.InboundEvent inbound_event = 2

  • EventGroupMarker.InboundUpdate inbound_update = 3

The event ID of an event in the present workflow that triggered implicit creation of this group Marker. The target event's type must be one of the following: - `WORKFLOW_EXECUTION_STARTED` - `WORKFLOW_EXECUTION_SIGNALED`

Used in: EventGroupMarker

• int64 inbound_event_id = 1

The identifier of an inbound Update (request.meta.update_id) whose handler triggered implicit creation of this group Marker. Used in place of `inbound_event_id` for Updates because the event ID of the UpdateAccepted history event is not known until the Workflow Task is completed and recorded by the server, which may be too late.

Used in: EventGroupMarker

• string inbound_update_id = 1

A user-defined short-form string value to be used as the group's label.

Used in: EventGroupMarker

• string id = 1

  Opaque identifier assigned by the SDK.

• optional common.v1.Payload label = 2

  This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may not apply to this text when used in "label" situations. The payload data section is limited to 400 bytes by default. Payload only needs to be set on the first use of a given Marker ID; further references to an existing Marker ID reuse existing attributes of the referenced Marker -- i.e. further label payloads are ignored. Note that it is valid to have distinct Markers (i.e. distinct Marker IDs) in a given workflow execution that carry the same label, provided that they have the distinct ID.

ExternalStorageReference identifies a payload stored in an external storage system. It is used as a claim-check token, allowing the actual payload data to be retrieved from the named driver using the provided claim data.

• string driver_name = 1

  The name of the storage driver responsible for retrieving the payload.

• map<string, string> claim_data = 2

  Driver-specific key-value pairs that identify and provide access to the stored payload.

Collection of FileLocation messages from a single stack.

Used in: EnhancedStackTrace

• repeated StackTraceFileLocation locations = 1

  Collection of `FileLocation`s, each for a stack frame that comprise a stack trace.

More specific location details of a file: its path, precise line and column numbers if applicable, and function name if available. In essence, a pointer to a location in a file

Used in: StackTrace

• string file_path = 1

  Path to source file (absolute or relative). If the paths are relative, ensure that they are all relative to the same root.

• int32 line = 2

  Optional; If possible, SDK should send this -- this is required for displaying the code location. If not provided, set to -1.

• int32 column = 3

  Optional; if possible, SDK should send this. If not provided, set to -1.

• string function_name = 4

  Function name this line belongs to, if applicable. Used for falling back to stack trace view.

• bool internal_code = 5

  Flag to communicate whether a location should be hidden by default in the stack view.

"Slice" of a file starting at line_offset -- a line offset and code fragment corresponding to the worker's stack.

Used in: EnhancedStackTrace

• uint32 line_offset = 1

  Only used (possibly) to trim the file without breaking syntax highlighting. This is not optional, unlike the `line` property of a `StackTraceFileLocation`. (-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: These really shouldn't have negative values. --)

• string content = 2

  Slice of a file with the respective OS-specific line terminator.

Information pertaining to the SDK that the trace has been captured from. (-- api-linter: core::0123::resource-annotation=disabled aip.dev/not-precedent: Naming SDK version is optional. --)

Used in: EnhancedStackTrace

• string name = 1

  Name of the SDK

• string version = 2

  Version string of the SDK

Information a user can set, often for use by user interfaces.

Used in: activity.v1.ActivityExecutionInfo, command.v1.Command, history.v1.HistoryEvent, nexus.v1.NexusOperationExecutionInfo, workflow.v1.NewWorkflowExecutionInfo, workflow.v1.WorkflowExecutionConfig, workflowservice.v1.SignalWithStartWorkflowExecutionRequest, workflowservice.v1.StartActivityExecutionRequest, workflowservice.v1.StartNexusOperationExecutionRequest, workflowservice.v1.StartWorkflowExecutionRequest

• optional common.v1.Payload summary = 1

  Short-form text that provides a summary. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may not apply to this text when used in "title" situations. The payload data section is limited to 400 bytes by default.

• optional common.v1.Payload details = 2

  Long-form text that provides details. This payload should be a "json/plain"-encoded payload that is a single JSON string for use in user interfaces. User interface formatting may apply to this text in common use. The payload data section is limited to 20000 bytes by default.

Used in: workflowservice.v1.FetchWorkerConfigResponse, workflowservice.v1.UpdateWorkerConfigRequest, workflowservice.v1.UpdateWorkerConfigResponse

• int32 workflow_cache_size = 1

• oneof poller_behavior

  • WorkerConfig.SimplePollerBehavior simple_poller_behavior = 2

  • WorkerConfig.AutoscalingPollerBehavior autoscaling_poller_behavior = 3

Used in: WorkerConfig

• int32 min_pollers = 1

  At least this many poll calls will always be attempted (assuming slots are available). Cannot be zero.

• int32 max_pollers = 2

  At most this many poll calls will ever be open at once. Must be >= `minimum`.

• int32 initial_pollers = 3

  This many polls will be attempted initially before scaling kicks in. Must be between `minimum` and `maximum`.

Used in: WorkerConfig

• int32 max_pollers = 1

(-- api-linter: core::0203::optional=disabled --)

Used in: WorkflowMetadata

• string type = 1

  A name scoped by the task queue that maps to this workflow definition. If missing, this workflow is a dynamic workflow.

• repeated WorkflowInteractionDefinition query_definitions = 2

  Query definitions, sorted by name.

• repeated WorkflowInteractionDefinition signal_definitions = 3

  Signal definitions, sorted by name.

• repeated WorkflowInteractionDefinition update_definitions = 4

  Update definitions, sorted by name.

(-- api-linter: core::0123::resource-annotation=disabled aip.dev/not-precedent: The `name` field is optional. --) (-- api-linter: core::0203::optional=disabled --)

Used in: WorkflowDefinition

• string name = 1

  An optional name for the handler. If missing, it represents a dynamic handler that processes any interactions not handled by others. There is at most one dynamic handler per workflow and interaction kind.

• string description = 2

  An optional interaction description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.

The name of the query to retrieve this information is `__temporal_workflow_metadata`.

• optional WorkflowDefinition definition = 1

  Metadata provided at declaration or creation time.

• string current_details = 2

  Current long-form details of the workflow's state. This is used by user interfaces to show long-form text. This text may be formatted by the user interface.

Used in: history.v1.WorkflowTaskCompletedEventAttributes, workflowservice.v1.RespondWorkflowTaskCompletedRequest

• repeated uint32 core_used_flags = 1

  Internal flags used by the core SDK. SDKs using flags must comply with the following behavior: During replay: * If a flag is not recognized (value is too high or not defined), it must fail the workflow task. * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for that flag during and after this WFT are allowed to assume that the flag is present. * If a code check for a flag does not find the flag in the set of used flags, it must take the branch corresponding to the absence of that flag. During non-replay execution of new WFTs: * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not previously recorded) flags when completing the WFT. SDKs which are too old to even know about this field at all are considered to produce undefined behavior if they replay workflows which used this mechanism. (-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: These really shouldn't have negative values. --)

• repeated uint32 lang_used_flags = 2

  Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages here as processing a workflow with a different language than the one which authored it is already undefined behavior. See `core_used_patches` for more. (-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: These really shouldn't have negative values. --)

• string sdk_name = 3

  Name of the SDK that processed the task. This is usually something like "temporal-go" and is usually the same as client-name gRPC header. This should only be set if its value changed since the last time recorded on the workflow (or be set on the first task). (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: We're ok with a name suffix here. --)

• string sdk_version = 4

  Version of the SDK that processed the task. This is usually something like "1.20.0" and is usually the same as client-version gRPC header. This should only be set if its value changed since the last time recorded on the workflow (or be set on the first task).