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

HttpPipelineBuilder proposal #43504

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

alzimmermsft
Copy link
Member

@alzimmermsft alzimmermsft commented Dec 19, 2024

Description

Changes how HttpPipelineBuilder works in the following ways:

  • Removed addPolicies(HttpPipelinePolicy...)
  • Added setRedirectPolicy(HttpRedirectPolicy), setRetryPolicy(HttpRetryPolicy), setCredentialPolicy(HttpCredentialPolicy), setLoggingPolicy(HttpLoggingPolicy), setTelemetryPolicy(HttpTelemetryPolicy), addPolicyBefore(HttpPipelinePolicy, HttpPipelinePosition), addPolicyBefore(HttpPipelinePolicy, String), addPolicyAfter(HttpPipelinePolicy, HttpPipelinePosition), addPolicyAfter(HttpPipelinePolicy, String), setPolicy(HttpPipelinePolicy), and removePolicy(String).

Added an enum HttpPipelinePosition, an abstract class HttpCredentialPolicy, and a to be implemented HttpTelemetryPolicy. Updated HttpPipelinePolicy to have getName(): String.

The changes made in this PR are meant to make the APIs used when creating an HttpPipeline using HttpPipelineBuilder more explanatory and to help guide a user through creating a high quality HttpPipeline.

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.

@azure-sdk
Copy link
Collaborator

API change check

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

io.clientcore:core

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants