Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Internal] Update Jobs GetRun API to support paginated responses for jobs and ForEach tasks #819

Merged
merged 2 commits into from
Nov 9, 2024

Conversation

gkiko10
Copy link
Contributor

@gkiko10 gkiko10 commented Nov 8, 2024

What changes are proposed in this pull request?

Introduces extension for jobs get_run call that paginates tasks and iterations arrays in the response and returns aggregated response to the caller. This change is necessary to prepare for jobs API 2.2 release that serves paginated response. Pagination is over once the next_page_token is absent from the response. The pagination logic is not exposed to the customer.

How is this tested?

Unit tests and manual test

Copy link

github-actions bot commented Nov 8, 2024

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/sdk-py

Inputs:

  • PR number: 819
  • Commit SHA: fa9f460941aa9147835c0c085a9e53793f21649d

Checks will be approved automatically on success.

@gkiko10 gkiko10 temporarily deployed to test-trigger-is November 8, 2024 14:33 — with GitHub Actions Inactive
@gkiko10 gkiko10 changed the title get_run paginates tasks and iterations [Internal] Update Jobs GetRun API to support paginated responses for jobs and ForEach tasks Nov 8, 2024
@eng-dev-ecosystem-bot
Copy link
Collaborator

Test Details: go/deco-tests/11755465331

@renaudhartert-db renaudhartert-db added this pull request to the merge queue Nov 9, 2024
Merged via the queue into databricks:main with commit 271502b Nov 9, 2024
19 of 20 checks passed
renaudhartert-db added a commit that referenced this pull request Nov 18, 2024
### New Features and Improvements

 * Read streams by 1MB chunks by default. ([#817](#817)).

### Bug Fixes

 * Rewind seekable streams before retrying ([#821](#821)).

### Internal Changes

 * Reformat SDK with YAPF 0.43. ([#822](#822)).
 * Update Jobs GetRun API to support paginated responses for jobs and ForEach tasks ([#819](#819)).
 * Update PR template ([#814](#814)).

### API Changes:

 * Added `databricks.sdk.service.apps`, `databricks.sdk.service.billing`, `databricks.sdk.service.catalog`, `databricks.sdk.service.compute`, `databricks.sdk.service.dashboards`, `databricks.sdk.service.files`, `databricks.sdk.service.iam`, `databricks.sdk.service.jobs`, `databricks.sdk.service.marketplace`, `databricks.sdk.service.ml`, `databricks.sdk.service.oauth2`, `databricks.sdk.service.pipelines`, `databricks.sdk.service.provisioning`, `databricks.sdk.service.serving`, `databricks.sdk.service.settings`, `databricks.sdk.service.sharing`, `databricks.sdk.service.sql`, `databricks.sdk.service.vectorsearch` and `databricks.sdk.service.workspace` packages.

OpenAPI SHA: 2035bf5234753adfd080a79bff325dd4a5b90bc2, Date: 2024-11-15
This was referenced Nov 18, 2024
github-merge-queue bot pushed a commit that referenced this pull request Nov 18, 2024
### New Features and Improvements

* Read streams by 1MB chunks by default.
([#817](#817)).

### Bug Fixes

* Rewind seekable streams before retrying
([#821](#821)).
 * Properly serialize nested data classes. 

### Internal Changes

* Reformat SDK with YAPF 0.43.
([#822](#822)).
* Update Jobs GetRun API to support paginated responses for jobs and
ForEach tasks
([#819](#819)).

### API Changes:

* Added `service_principal_client_id` field for
`databricks.sdk.service.apps.App`.
* Added `azure_service_principal`, `gcp_service_account_key` and
`read_only` fields for
`databricks.sdk.service.catalog.CreateCredentialRequest`.
* Added `azure_service_principal`, `read_only` and
`used_for_managed_storage` fields for
`databricks.sdk.service.catalog.CredentialInfo`.
* Added `omit_username` field for
`databricks.sdk.service.catalog.ListTablesRequest`.
* Added `azure_service_principal` and `read_only` fields for
`databricks.sdk.service.catalog.UpdateCredentialRequest`.
* Added `external_location_name`, `read_only` and `url` fields for
`databricks.sdk.service.catalog.ValidateCredentialRequest`.
* Added `is_dir` field for
`databricks.sdk.service.catalog.ValidateCredentialResponse`.
 * Added `only` field for `databricks.sdk.service.jobs.RunNow`.
* Added `restart_window` field for
`databricks.sdk.service.pipelines.CreatePipeline`.
* Added `restart_window` field for
`databricks.sdk.service.pipelines.EditPipeline`.
* Added `restart_window` field for
`databricks.sdk.service.pipelines.PipelineSpec`.
* Added `private_access_settings_id` field for
`databricks.sdk.service.provisioning.UpdateWorkspaceRequest`.
* Changed `create_credential()` and
`generate_temporary_service_credential()` methods for
[w.credentials](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/credentials.html)
workspace-level service with new required argument order.
* Changed `access_connector_id` field for
`databricks.sdk.service.catalog.AzureManagedIdentity` to be required.
* Changed `access_connector_id` field for
`databricks.sdk.service.catalog.AzureManagedIdentity` to be required.
* Changed `name` field for
`databricks.sdk.service.catalog.CreateCredentialRequest` to be required.
* Changed `credential_name` field for
`databricks.sdk.service.catalog.GenerateTemporaryServiceCredentialRequest`
to be required.

OpenAPI SHA: f2385add116e3716c8a90a0b68e204deb40f996c, Date: 2024-11-15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants