package temporal.api.failure.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Failure

• int64 scheduled_event_id = 1

• int64 started_event_id = 2

• string identity = 3

• optional common.v1.ActivityType activity_type = 4

• string activity_id = 5

• enums.v1.RetryState retry_state = 6

Used in: Failure

• string type = 1

• bool non_retryable = 2

• optional common.v1.Payloads details = 3

• optional google.protobuf.Duration next_retry_delay = 4

  next_retry_delay can be used by the client to override the activity retry interval calculated by the retry policy. Retry attempts will still be subject to the maximum retries limit and total time limit defined by the policy.

• enums.v1.ApplicationErrorCategory category = 5

Used in: Failure

• optional common.v1.Payloads details = 1

• string identity = 2

  The identity of the worker or client that requested the cancellation.

Used in: Failure

• string namespace = 1

• optional common.v1.WorkflowExecution workflow_execution = 2

• optional common.v1.WorkflowType workflow_type = 3

• int64 initiated_event_id = 4

• int64 started_event_id = 5

• enums.v1.RetryState retry_state = 6

Used in: activity.v1.ActivityExecutionInfo, activity.v1.ActivityExecutionOutcome, callback.v1.CallbackInfo, command.v1.ContinueAsNewWorkflowExecutionCommandAttributes, command.v1.FailWorkflowExecutionCommandAttributes, command.v1.RecordMarkerCommandAttributes, errordetails.v1.QueryFailedFailure, history.v1.ActivityTaskFailedEventAttributes, history.v1.ActivityTaskStartedEventAttributes, history.v1.ActivityTaskTimedOutEventAttributes, history.v1.ChildWorkflowExecutionFailedEventAttributes, history.v1.MarkerRecordedEventAttributes, history.v1.NexusOperationCancelRequestFailedEventAttributes, history.v1.NexusOperationCanceledEventAttributes, history.v1.NexusOperationFailedEventAttributes, history.v1.NexusOperationTimedOutEventAttributes, history.v1.WorkflowExecutionContinuedAsNewEventAttributes, history.v1.WorkflowExecutionFailedEventAttributes, history.v1.WorkflowExecutionStartedEventAttributes, history.v1.WorkflowExecutionUpdateRejectedEventAttributes, history.v1.WorkflowTaskFailedEventAttributes, nexus.v1.NexusOperationExecutionCancellationInfo, nexus.v1.NexusOperationExecutionInfo, nexus.v1.StartOperationResponse, query.v1.WorkflowQueryResult, update.v1.Outcome, update.v1.Rejection, workflow.v1.CallbackInfo, workflow.v1.NexusOperationCancellationInfo, workflow.v1.PendingActivityInfo, workflow.v1.PendingNexusOperationInfo, workflowservice.v1.DescribeNexusOperationExecutionResponse, workflowservice.v1.PollNexusOperationExecutionResponse, workflowservice.v1.RespondActivityTaskFailedByIdRequest, workflowservice.v1.RespondActivityTaskFailedByIdResponse, workflowservice.v1.RespondActivityTaskFailedRequest, workflowservice.v1.RespondActivityTaskFailedResponse, workflowservice.v1.RespondNexusTaskFailedRequest, workflowservice.v1.RespondQueryTaskCompletedRequest, workflowservice.v1.RespondWorkflowTaskFailedRequest, workflowservice.v1.StartWorkflowExecutionRequest

• string message = 1

• string source = 2

  The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK In some SDKs this is used to rehydrate the stack trace into an exception object.

• string stack_trace = 3

• optional common.v1.Payload encoded_attributes = 20

  Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of errors originating in user code which might contain sensitive information. The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto message. SDK authors: - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that: - Uses a JSON object to represent `{ message, stack_trace }`. - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted. - Overwrites the original stack_trace with an empty string. - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed by the user-provided PayloadCodec - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes. (-- api-linter: core::0203::optional=disabled --)

• optional Failure cause = 4

• oneof failure_info

  • ApplicationFailureInfo application_failure_info = 5

  • TimeoutFailureInfo timeout_failure_info = 6

  • CanceledFailureInfo canceled_failure_info = 7

  • TerminatedFailureInfo terminated_failure_info = 8

  • ServerFailureInfo server_failure_info = 9

  • ResetWorkflowFailureInfo reset_workflow_failure_info = 10

  • ActivityFailureInfo activity_failure_info = 11

  • ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12

  • NexusOperationFailureInfo nexus_operation_execution_failure_info = 13

  • NexusHandlerFailureInfo nexus_handler_failure_info = 14

(message has no fields)

Used in: Failure

• string type = 1

  The Nexus error type as defined in the spec: https://github.com/nexus-rpc/api/blob/main/SPEC.md#predefined-handler-errors.

• enums.v1.NexusHandlerErrorRetryBehavior retry_behavior = 2

  Retry behavior, defaults to the retry behavior of the error type as defined in the spec.

Representation of the Temporal SDK NexusOperationError object that is returned to workflow callers.

Used in: Failure

• int64 scheduled_event_id = 1

  The NexusOperationScheduled event ID.

• string endpoint = 2

  Endpoint name.

• string service = 3

  Service name.

• string operation = 4

  Operation name.

• string operation_id = 5

  Operation ID - may be empty if the operation completed synchronously. Deprecated. Renamed to operation_token.

• string operation_token = 6

  Operation token - may be empty if the operation completed synchronously.

Used in: Failure

• optional common.v1.Payloads last_heartbeat_details = 1

Used in: Failure

• bool non_retryable = 1

Used in: Failure

• string identity = 1

  The identity of the worker or client that requested the termination.

Used in: Failure

• enums.v1.TimeoutType timeout_type = 1

• optional common.v1.Payloads last_heartbeat_details = 2