Add include_heartbeat_details and include_last_failure to DescribeActivityExecutionRequest#792
Open
maciejdudko wants to merge 2 commits into
Conversation
…ivityExecutionRequest
Sushisource
approved these changes
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed?
Added
include_heartbeat_detailsandinclude_last_failuretoDescribeActivityExecutionRequest. The intention is that by default,ActivityExecutionInfowill omitheartbeat_detailsandlast_failure.Why?
heartbeat_detailsandlast_failureare user-controlled payloads and potentially very large. These changes allow sending these payloads only when specifically requested, reducing message size when they aren't needed.Breaking changes
This PR changes what the default behavior of
DescribeActivityExecutionshould be. The old behavior is equivalent to setting bothinclude_heartbeat_detailsandinclude_last_failureto true. The server does not need to be immediately updated since the current implementation is functional with new API - however, once server implements the new API, old clients will break if they rely on the old behavior. Note that SAA APIs are in Public Preview and breaking changes can happen.Server PR
TBD