Interface HttpTrait<T extends HttpTrait<T>>
- Type Parameters:
T
- The concrete type that implements the trait. This is required so that fluent operations can continue to return the concrete type, rather than the trait type.
Azure SDK for Java trait
providing a consistent interface for configuration
of HTTP-specific settings. Refer to the Azure SDK for Java
HTTP clients and pipelines
documentation for more details on proper usage and configuration of the Azure SDK for Java HTTP clients.
It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored.
If no HttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings
provided to this trait. Additionally, there may be other APIs in types that implement this
trait that are also ignored if an HttpPipeline
is specified, so please be sure to refer to the
documentation of types that implement this trait to understand the full set of implications.
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(HttpPipelinePolicy pipelinePolicy) Adds apipeline policy
to apply on each request sent.clientOptions
(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.httpClient
(HttpClient httpClient) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.
-
Method Details
-
httpClient
Sets theHttpClient
to use for sending and receiving requests to and from the service.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
pipeline
Sets theHttpPipeline
to use for the service client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
addPolicy
Adds apipeline policy
to apply on each request sent.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
retryOptions
Sets theRetryOptions
for all the requests made through the client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
httpLogOptions
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.NONE
is set.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
clientOptions
Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of theHttpClientOptions
class (a subclass of theClientOptions
base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipeline
is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipeline
is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
- See Also:
-