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

Batch: Add Support for Options Bags and Certificates to Dataplane SDK #44722

Merged
merged 24 commits into from
Mar 24, 2025

Conversation

skapur12
Copy link
Member

@skapur12 skapur12 commented Mar 19, 2025

Description

This PR is to add support in the Java SDK for the officially generated options bag (basically a grouping of optional parameters instead of having them in a flat list). This allows us to add more optional parameters in the future without it being a breaking change, and prevents the customer from having to pass in null many times.
For example, instead of this:
void deleteTaskFile(String jobId, String taskId, String filePath, Integer timeOutInSeconds, Boolean recursive)
We now have this:
public void deleteTaskFile(String jobId, String taskId, String filePath, DeleteBatchTaskFileOptions options)
Only the optional parameters are grouped, not the required ones.

We are also adding support for certificates back into the Java SDK (we were told to remove it a few months ago as the Batch service was set to deprecate it, but due to some delays been deprecated yet, so we are adding it back in).

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@github-actions github-actions bot added the Batch label Mar 19, 2025
@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

com.azure:azure-compute-batch

@skapur12 skapur12 marked this pull request as ready for review March 22, 2025 00:29
Copy link
Member

@wiboris wiboris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would have been good to have some certificate tests

@skapur12 skapur12 merged commit 296f1fa into main Mar 24, 2025
32 checks passed
@skapur12 skapur12 deleted the sanjanakapur/add-batch-options-bag branch March 24, 2025 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants