feat(gooddata-sdk): [AUTO] add retrieve_result_binary wrapper for Arrow binary endpoint#1464
Closed
yenkins-admin wants to merge 1 commit intomasterfrom
Closed
feat(gooddata-sdk): [AUTO] add retrieve_result_binary wrapper for Arrow binary endpoint#1464yenkins-admin wants to merge 1 commit intomasterfrom
yenkins-admin wants to merge 1 commit intomasterfrom
Conversation
…ow binary endpoint
Expose the new retrieveResultBinary API endpoint (GET /result/{resultId}/binary)
in the SDK wrapper layer. Adds read_result_binary() to BareExecutionResponse and
Execution, and retrieve_result_binary() to ComputeService.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1464 +/- ##
==========================================
- Coverage 77.27% 77.27% -0.01%
==========================================
Files 227 227
Lines 14687 14695 +8
==========================================
+ Hits 11350 11355 +5
- Misses 3337 3340 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Add SDK wrapper methods exposing the new
retrieveResultBinaryArrow binary endpoint introduced in gdc-nas after the ExecuteResultController refactor.Problem: P004 | Workflow: https://github.com/gooddata/gdc-nas/actions/runs/23238229346
What changed in gdc-nas
The
ExecuteResultControllerwas refactored (commit 81eb97a, PR #21382) to consolidate two separate Arrow endpoints (retrieveResultArrowFileandretrieveResultArrowStream) that previously lived at/result/{resultId}alongside the JSON endpoint into a single new endpoint:GET /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary(operationId: retrieveResultBinary) — serves both Arrow File and Arrow Stream via content negotiation using theAcceptheaderretrieveResultArrowFileandretrieveResultArrowStream(both previously at/result/{resultId})GET /result/{resultId}(operationId: retrieveResult) — Arrow content types removed; now JSON-onlyDataBufferschema from OpenAPI components,clearArrowResponseSchemas()boilerplate, andassertNoPagingParams()validationThe
gooddata-api-clientwas already regenerated with the newretrieve_result_binaryoperation inactions_api.pyandcomputation_api.py.What was implemented in SDK
Added wrapper methods to expose the new binary endpoint to SDK users:
BareExecutionResponse.read_result_binary()andExecution.read_result_binary()inexecution.py— instance methods on the execution response objects, callingself._actions_api.retrieve_result_binary()with_check_return_type=Falseand_preload_content=Falseto return raw bytesComputeService.retrieve_result_binary()inservice.py— flat service-level entry point for the same endpointA dedicated unit test file
test_retrieve_result_binary.pywas added with mock-based tests verifying correct parameter forwarding and return value.Files modified
packages/gooddata-sdk/src/gooddata_sdk/compute/model/execution.pypackages/gooddata-sdk/src/gooddata_sdk/compute/service.pypackages/gooddata-sdk/tests/compute/test_retrieve_result_binary.pyJIRA: PENDING (Jira ticket will be created after review)
Risk: Low