Skip to content

Commit 6b38f4d

Browse files
authored
Removed mentions of HttpPipeline in HttpTrait. (Azure#45134)
1 parent 1589473 commit 6b38f4d

File tree

1 file changed

+1
-45
lines changed
  • sdk/clientcore/core/src/main/java/io/clientcore/core/traits

1 file changed

+1
-45
lines changed

sdk/clientcore/core/src/main/java/io/clientcore/core/traits/HttpTrait.java

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,21 @@
55

66
import io.clientcore.core.http.client.HttpClient;
77
import io.clientcore.core.http.pipeline.HttpInstrumentationOptions;
8+
import io.clientcore.core.http.pipeline.HttpPipelinePolicy;
89
import io.clientcore.core.http.pipeline.HttpRedirectOptions;
910
import io.clientcore.core.http.pipeline.HttpRetryOptions;
10-
import io.clientcore.core.http.pipeline.HttpPipeline;
11-
import io.clientcore.core.http.pipeline.HttpPipelinePolicy;
1211

1312
/**
1413
* A {@link io.clientcore.core.traits trait} providing a consistent interface for configuration of HTTP-specific
1514
* settings. Refer to the
1615
* <a href="https://aka.ms/azsdk/java/docs/http-client-pipeline">HTTP clients and pipelines</a> documentation for more
1716
* details on proper usage and configuration of HTTP clients.
1817
*
19-
* <p>It is important to understand the precedence order of the {@link HttpTrait} APIs. In particular, if an
20-
* {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and they will be ignored.
21-
* If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally based on the settings
22-
* provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also
23-
* ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the documentation of types that
24-
* implement this trait to understand the full set of implications.</p>
25-
*
2618
* @param <T> The concrete type that implements the trait. This is required so that fluent operations can continue to
2719
* return the concrete type, rather than the trait type.
2820
*
2921
* @see io.clientcore.core.traits
3022
* @see HttpClient
31-
* @see HttpPipeline
3223
* @see HttpPipelinePolicy
3324
* @see HttpInstrumentationOptions
3425
* @see HttpRetryOptions
@@ -38,13 +29,6 @@ public interface HttpTrait<T extends HttpTrait<T>> {
3829
/**
3930
* Sets the {@link HttpClient} to use for sending and receiving requests to and from the service.
4031
*
41-
* <p><strong>Note:</strong> It is important to understand the precedence order of the {@link HttpTrait} APIs. In
42-
* particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
43-
* they will be ignored. If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally
44-
* based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
45-
* trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
46-
* documentation of types that implement this trait to understand the full set of implications.</p>
47-
*
4832
* @param client The {@link HttpClient} to use for requests.
4933
*
5034
* @return Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of
@@ -55,13 +39,6 @@ public interface HttpTrait<T extends HttpTrait<T>> {
5539
/**
5640
* Adds a {@link HttpPipelinePolicy pipeline policy} to apply on each request sent.
5741
*
58-
* <p><strong>Note:</strong> It is important to understand the precedence order of the {@link HttpTrait} APIs. In
59-
* particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
60-
* they will be ignored. If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally
61-
* based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
62-
* trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
63-
* documentation of types that implement this trait to understand the full set of implications.</p>
64-
*
6542
* @param pipelinePolicy A {@link HttpPipelinePolicy pipeline policy}.
6643
*
6744
* @return Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of
@@ -74,13 +51,6 @@ public interface HttpTrait<T extends HttpTrait<T>> {
7451
/**
7552
* Sets the {@link HttpRetryOptions} for all the requests made through the client.
7653
*
77-
* <p><strong>Note:</strong> It is important to understand the precedence order of the {@link HttpTrait} APIs. In
78-
* particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
79-
* they will be ignored. If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally
80-
* based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
81-
* trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
82-
* documentation of types that implement this trait to understand the full set of implications.</p>
83-
*
8454
* @param retryOptions The {@link HttpRetryOptions} to use for all the requests made through the client.
8555
*
8656
* @return Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of
@@ -105,13 +75,6 @@ public interface HttpTrait<T extends HttpTrait<T>> {
10575
* the details.</li>
10676
* </ul>
10777
*
108-
* <p><strong>Note:</strong> It is important to understand the precedence order of the {@link HttpTrait} APIs. In
109-
* particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
110-
* they will be ignored. If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally
111-
* based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
112-
* trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
113-
* documentation of types that implement this trait to understand the full set of implications.</p>
114-
*
11578
* @param instrumentationOptions The {@link HttpInstrumentationOptions configuration} to use when recording telemetry about HTTP
11679
* requests sent to the service and responses received from it.
11780
*
@@ -123,13 +86,6 @@ public interface HttpTrait<T extends HttpTrait<T>> {
12386
/**
12487
* Sets the {@link HttpRedirectOptions} for all the requests made through the client.
12588
*
126-
* <p><strong>Note:</strong> It is important to understand the precedence order of the {@link HttpTrait} APIs. In
127-
* particular, if a {@link HttpPipeline} is specified, this takes precedence over all other APIs in the trait, and
128-
* they will be ignored. If no {@link HttpPipeline} is specified, an HTTP pipeline will be constructed internally
129-
* based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this
130-
* trait that are also ignored if an {@link HttpPipeline} is specified, so please be sure to refer to the
131-
* documentation of types that implement this trait to understand the full set of implications.</p>
132-
*
13389
* @param redirectOptions The {@link HttpRedirectOptions} to use for all the requests made through the client.
13490
*
13591
* @return Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of

0 commit comments

Comments
 (0)