PartialRequest
Describes a partial HTTP request, along with a description of how the response body should be handled. A partial request cannot be sent because the method and uri are not yet specified.
Type parameters
- T
-
The target type, to which the response body should be read.
Value parameters
- response
-
Description of how the response body should be handled. Needs to be specified upfront so that the response is always consumed and hence there are no requirements on client code to consume it.
- tags
-
Request-specific tags which can be used by backends for logging, metrics, etc. Empty by default.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait HasHeadersclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Set the method & uri to the given ones.
Attributes
- Definition Classes
Replace all headers with the given ones.
Replace all options with the given ones.
Replace all tags with the given ones.
Inherited methods
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.
Attributes
- Inherited from:
- PartialRequestBuilder
Encodes the given parameters as form data using utf-8
. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
Encodes the given parameters as form data using utf-8
. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.
Attributes
- Inherited from:
- PartialRequestBuilder
Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.
Attributes
- Inherited from:
- PartialRequestBuilder
Encodes the given parameters as form data using utf-8
. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
Encodes the given parameters as form data using utf-8
. If content type is not yet specified, will be set to application/x-www-form-urlencoded
.
If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.
Attributes
- Inherited from:
- PartialRequestBuilder
If content type is not yet specified, will be set to application/octet-stream
.
If content type is not yet specified, will be set to application/octet-stream
.
Attributes
- Inherited from:
- PartialRequestBuilder
If content type is not yet specified, will be set to application/octet-stream
.
If content type is not yet specified, will be set to application/octet-stream
.
Attributes
- Inherited from:
- PartialRequestBuilder
If content type is not yet specified, will be set to application/octet-stream
.
If content type is not yet specified, will be set to application/octet-stream
.
If content length is not yet specified, will be set to the length of the given array.
Attributes
- Inherited from:
- PartialRequestBuilder
If content type is not yet specified, will be set to text/plain
with the given encoding.
If content type is not yet specified, will be set to text/plain
with the given encoding.
If content length is not yet specified, will be set to the number of bytes in the string using the given encoding.
Attributes
- Inherited from:
- PartialRequestBuilder
Uses the utf-8
encoding.
Uses the utf-8
encoding.
If content type is not yet specified, will be set to text/plain
with utf-8
encoding.
If content length is not yet specified, will be set to the number of bytes in the string using the utf-8
encoding.
Attributes
- Inherited from:
- PartialRequestBuilder
If content type is not yet specified, will be set to application/octet-stream
.
If content type is not yet specified, will be set to application/octet-stream
.
Attributes
- Inherited from:
- PartialRequestExtensions
If content type is not yet specified, will be set to application/octet-stream
.
If content type is not yet specified, will be set to application/octet-stream
.
If content length is not yet specified, will be set to the length of the given file.
Attributes
- Inherited from:
- PartialRequestExtensions
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Adds the given cookie. Any previously defined cookies are left intact.
Adds the given cookie. Any previously defined cookies are left intact.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given cookie. Any previously defined cookies are left intact.
Adds the given cookie. Any previously defined cookies are left intact.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given cookies. Any previously defined cookies are left intact.
Adds the given cookies. Any previously defined cookies are left intact.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given cookies. Any previously defined cookies are left intact.
Adds the given cookies. Any previously defined cookies are left intact.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the cookies from the given response. Any previously defined cookies are left intact.
Adds the cookies from the given response. Any previously defined cookies are left intact.
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the headers of this request, if the value is defined. Otherwise has no effect. If a header with the same name already exists, it's replaced.
Adds the given header to the headers of this request, if the value is defined. Otherwise has no effect. If a header with the same name already exists, it's replaced.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the headers of this request. If a header with the same name already exists, it's replaced.
Adds the given header to the headers of this request. If a header with the same name already exists, it's replaced.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the headers of this request.
Adds the given header to the headers of this request.
Value parameters
- onDuplicate
-
What should happen if there's already a header with the same name. See header.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the headers of this request. If a header with the same name already exists, the default is to replace it with the given one.
Adds the given header to the headers of this request. If a header with the same name already exists, the default is to replace it with the given one.
Value parameters
- onDuplicate
-
What should happen if there's already a header with the same name. The default is to replace.
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Adds the given headers to the headers of this request. If a header with the same name already exists, it's replaced.
Adds the given headers to the headers of this request. If a header with the same name already exists, it's replaced.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given headers to the headers of this request. If a header with the same name already exists, it's replaced.
Adds the given headers to the headers of this request. If a header with the same name already exists, it's replaced.
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
GetHttpVersion from tags in request. Supported only is a few backends
GetHttpVersion from tags in request. Supported only is a few backends
Attributes
- Returns
-
one of values form HttpVersion enum or None
- Inherited from:
- PartialRequestBuilder
Allows setting HTTP version per request. Supported only is a few backends
Allows setting HTTP version per request. Supported only is a few backends
Value parameters
- version:
-
one of values from HttpVersion enum.
Attributes
- Returns
-
request with version tag
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Will only have effect when using the LoggingBackend
Will only have effect when using the LoggingBackend
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- Product
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
When the request is sent, if reading the response times out (there's no activity for the given period of time), a failed effect will be returned, or an exception will be thrown
When the request is sent, if reading the response times out (there's no activity for the given period of time), a failed effect will be returned, or an exception will be thrown
Attributes
- Inherited from:
- PartialRequestBuilder
When a POST or PUT request is redirected, should the redirect be a POST/PUT as well (with the original body), or should the request be converted to a GET without a body.
When a POST or PUT request is redirected, should the redirect be a POST/PUT as well (with the original body), or should the request be converted to a GET without a body.
Note that this only affects 301 and 302 redirects. 303 redirects are always converted, while 307 and 308 redirects always keep the same method.
See https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections for details.
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Attributes
- Inherited from:
- PartialRequestBuilder