core/sttp.client3/RequestT

RequestT

case class RequestT[U[_], T, -R](method: U[Method], uri: U[Uri], body: RequestBody[R], headers: Seq[Header], response: ResponseAs[T, R], options: RequestOptions, tags: Map[String, Any]) extends HasHeaders with RequestTExtensions[U, T, R]

Describes a HTTP request, along with a description of how the response body should be handled.

The request can be sent using a SttpBackend, which provides a superset of the required capabilities.

Type Params
R

The backend capabilities required by the request or response description. This might be Any (no requirements), Effect (the backend must support the given effect type), 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.

U

Specifies if the method & uri are specified. By default can be either: * Empty, which is a type constructor which always resolves to None. This type of request is aliased to PartialRequest: there's no method and uri specified, and the request cannot be sent. * Identity, which is an identity type constructor. This type of request is aliased to Request: the method and uri are specified, and the request can be sent.

Value Params
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. An exception to this are unsafe streaming and websocket responses, which need to be consumed/closed by the client.

tags

Request-specific tags which can be used by backends for logging, metrics, etc. Not used by default.

Companion
object
trait Serializable
trait Product
trait Equals
trait RequestTExtensions[U, T, R]
trait HasHeaders
class Object
trait Matchable
class Any

Value members

Concrete methods

def acceptEncoding(encoding: String): RequestT[U, T, R]
def auth: SpecifyAuthScheme[U, T, R]
def body(b: String): RequestT[U, T, R]

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.

def body(b: String, encoding: String): RequestT[U, T, R]

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.

def body(b: Array[Byte]): RequestT[U, T, R]

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.

def body(b: ByteBuffer): RequestT[U, T, R]

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.

def body(b: InputStream): RequestT[U, T, R]

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.

def body(fs: Map[String, String]): RequestT[U, T, R]

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.

def body(fs: Map[String, String], encoding: String): RequestT[U, T, R]

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.

def body(fs: (String, String)*): RequestT[U, T, R]

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.

def body(fs: Seq[(String, String)], encoding: String): RequestT[U, T, R]

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.

def contentLength(l: Long): RequestT[U, T, R]
def contentType(ct: String): RequestT[U, T, R]
def contentType(mt: MediaType): RequestT[U, T, R]
def contentType(ct: String, encoding: String): RequestT[U, T, R]
def cookies(r: Response[_]): RequestT[U, T, R]
def cookies(cs: Iterable[CookieWithMeta]): RequestT[U, T, R]
def cookies(nvs: (String, String)*): RequestT[U, T, R]
def delete(uri: Uri): Request[T, R]
def followRedirects(fr: Boolean): RequestT[U, T, R]
def get(uri: Uri): Request[T, R]
def head(uri: Uri): Request[T, R]
def header(h: Header, replaceExisting: Boolean): RequestT[U, T, R]

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

Value Params
replaceExisting

If there's already a header with the same name, should it be dropped?

def header(k: String, v: String, replaceExisting: Boolean): RequestT[U, T, R]

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

Value Params
replaceExisting

If there's already a header with the same name, should it be dropped?

def header(k: String, v: String): RequestT[U, T, R]

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

def header(k: String, ov: Option[String]): RequestT[U, T, R]

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.

def headers(hs: Map[String, String]): RequestT[U, T, R]
def headers(hs: Header*): RequestT[U, T, R]
def isWebSocket: Boolean
def mapResponse[T2](f: T => T2): RequestT[U, T2, R]
def maxRedirects(n: Int): RequestT[U, T, R]
def method(method: Method, uri: Uri): Request[T, R]
def multipartBody[R2](ps: Seq[Part[RequestBody[R2]]]): RequestT[U, T, R & R2]
def multipartBody[R2](p1: Part[RequestBody[R2]], ps: Part[RequestBody[R2]]*): RequestT[U, T, R & R2]
def options(uri: Uri): Request[T, R]
def patch(uri: Uri): Request[T, R]
def post(uri: Uri): Request[T, R]
def put(uri: Uri): Request[T, R]
def readTimeout(t: Duration): RequestT[U, T, R]

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

def redirectToGet(r: Boolean): RequestT[U, T, R]

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.

def response[T2, R2](ra: ResponseAs[T2, R2]): RequestT[U, T2, R & R2]

Specifies the target type to which the response body should be read. Note that this replaces any previous specifications, which also includes any previous mapResponse invocations.

Specifies the target type to which the response body should be read. Note that this replaces any previous specifications, which also includes any previous mapResponse invocations.

def send[F[_], P](backend: SttpBackend[F, P])(implicit isIdInRequest: IsIdInRequest[U], pEffectFIsR: P & Effect[F] <:< R): F[Response[T]]

Sends the request, using the given backend. Only requests for which the method & URI are specified can be sent.

Sends the request, using the given backend. Only requests for which the method & URI are specified can be sent.

The required capabilities must be a subset of the capabilities provided by the backend.

Returns

For synchronous backends (when the effect type is Identity), Response is returned directly and exceptions are thrown. For asynchronous backends (when the effect type is e.g. scala.concurrent.Future), an effect containing the Response is returned. Exceptions are represented as failed effects (e.g. failed futures). The response body is deserialized as specified by this request (see RequestT.response). Known exceptions are converted by backends to one of SttpClientException. Other exceptions are thrown unchanged.

def show(includeBody: Boolean, includeHeaders: Boolean, sensitiveHeaders: Set[String]): String
def showBasic: String
def streamBody[S](s: Streams[S])(b: BinaryStream): RequestT[U, T, R & S]
def tag(k: String, v: Any): RequestT[U, T, R]
def tag(k: String): Option[Any]
def toCurl(implicit isIdInRequest: IsIdInRequest[U]): String
def toRfc2616Format(implicit isIdInRequest: IsIdInRequest[U]): String

Deprecated methods

@deprecated(message = "use request.send(backend), providing the backend explicitly", since = "3.0.0")
def send[F[_], P](implicit backend: SttpBackend[F, P], pEffectFIsR: P & Effect[F] <:< R, isIdInRequest: IsIdInRequest[U]): F[Response[T]]

Sends the request, using the backend from the implicit scope. Only requests for which the method & URI are specified can be sent.

Sends the request, using the backend from the implicit scope. Only requests for which the method & URI are specified can be sent.

The required capabilities must be a subset of the capabilities provided by the backend.

Returns

For synchronous backends (when the effect type is Identity), Response is returned directly and exceptions are thrown. For asynchronous backends (when the effect type is e.g. scala.concurrent.Future), an effect containing the Response is returned. Exceptions are represented as failed effects (e.g. failed futures). The response body is deserialized as specified by this request (see RequestT.response). Known exceptions are converted by backends to one of SttpClientException. Other exceptions are thrown unchanged.

Deprecated
[Since version 3.0.0] use request.send(backend), providing the backend explicitly

Inherited methods

def body[B](b: B)(implicit evidence$1: () => B): RequestT[U, T, R]

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.

Inherited from
RequestTExtensions
def body(file: File): RequestT[U, T, R]

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.

Inherited from
RequestTExtensions
def contentLength: Option[Long]
Inherited from
HasHeaders
def contentType: Option[String]
Inherited from
HasHeaders
def cookies: Seq[Either[String, CookieWithMeta]]
Inherited from
HasHeaders
def header(h: String): Option[String]
Inherited from
HasHeaders
def headers(h: String): Seq[String]
Inherited from
HasHeaders
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def unsafeCookies: Seq[CookieWithMeta]
Inherited from
HasHeaders