GenericRequest
A generic description of an HTTP request, along with a description of how the response body should be handled.
Client code should use concrete subtypes of this trait. The Request.send, StreamRequest.send, WebSocketRequest.send or WebSocketStreamRequest.send methods should be used to send the request, providing an instance of the appropriate Backend subtype.
However, the request can aso be sent using the GenericBackend.send method, which provides a superset of the required capabilities.
Type parameters
- R
-
The backend capabilities required by the request or response description. This might be
Any
(no requirements), sttp.capabilities.Effect (the backend must support the given effect type), sttp.capabilities.Streams (the ability to send and receive streaming bodies) or sttp.capabilities.WebSockets (the ability to handle websocket requests). - T
-
The target type, to which the response body should be read.
Attributes
- Graph
-
- Supertypes
-
trait RequestMetadatatrait HasHeadersclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class Request[T]
Members list
Value members
Abstract methods
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.
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.
Attributes
Concrete methods
Metadata of the request, which doesn't retain the request body, or the response handling specification.
Metadata of the request, which doesn't retain the request body, or the response handling specification.
Attributes
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
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 noBodySerializert yet specified, will be set to the length of the given file.
Attributes
- Inherited from:
- PartialRequestExtensions
Attributes
- Inherited from:
- HasHeaders
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
Attributes
- Inherited from:
- HasHeaders
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:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Adds the given header to the end of the headers sequence, if the value is defined. Otherwise has no effect.
Adds the given header to the end of the headers sequence, if the value is defined. Otherwise has no effect.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the end of the headers sequence.
Adds the given header to the end of the headers sequence.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the end of the headers sequence.
Adds the given header to the end of the headers sequence.
Value parameters
- replaceExisting
-
If there's already a header with the same name, should it be replaced?
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given header to the end of the headers sequence.
Adds the given header to the end of the headers sequence.
Value parameters
- replaceExisting
-
If there's already a header with the same name, should it be replaced?
Attributes
- Inherited from:
- PartialRequestBuilder
Attributes
- Inherited from:
- HasHeaders
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given headers to the end of the headers sequence.
Adds the given headers to the end of the headers sequence.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given headers to the end of the headers sequence.
Adds the given headers to the end of the headers sequence.
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given headers to the end of the headers sequence.
Adds the given headers to the end of the headers sequence.
Value parameters
- replaceExisting
-
If there's already a header with the same name, should it be replaced?
Attributes
- Inherited from:
- PartialRequestBuilder
Adds the given headers to the end of the headers sequence.
Adds the given headers to the end of the headers sequence.
Attributes
- Inherited from:
- PartialRequestBuilder
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
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:
- RequestMetadata
Set the method & uri to the given ones.
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
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:
- PartialRequestBuilder
Request-specific tags which can be used by backends for logging, metrics, etc. Empty by default.
Request-specific tags which can be used by backends for logging, metrics, etc. Empty by default.
Attributes
- Inherited from:
- PartialRequestBuilder
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
RequestMetadata -> Any
- Inherited from:
- RequestMetadata
Attributes
- Inherited from:
- HasHeaders
Attributes
- Inherited from:
- RequestMetadata
Attributes
- Inherited from:
- PartialRequestBuilder
Replace all headers with the given ones.
Replace all options with the given ones.
Replace all tags with the given ones.