Trait

sttp.client

SttpApi

Related Doc: package client

Permalink

trait SttpApi extends SttpExtensions with UriInterpolator

Linear Supertypes
UriInterpolator, SttpExtensions, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SttpApi
  2. UriInterpolator
  3. SttpExtensions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class UriContext extends AnyRef

    Permalink
    Definition Classes
    UriInterpolator

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val DefaultReadTimeout: Duration

    Permalink
  5. def asByteArray: ResponseAs[Either[String, Array[Byte]], Nothing]

    Permalink
  6. def asByteArrayAlways: ResponseAs[Array[Byte], Nothing]

    Permalink
  7. def asEither[L, R, S](onError: ResponseAs[L, S], onSuccess: ResponseAs[R, S]): ResponseAs[Either[L, R], S]

    Permalink
  8. def asFile(file: File): ResponseAs[Either[String, File], Nothing]

    Permalink
    Definition Classes
    SttpExtensions
  9. def asFileAlways(file: File): ResponseAs[File, Nothing]

    Permalink
    Definition Classes
    SttpExtensions
  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def asParams(charset: String): ResponseAs[Either[String, Seq[(String, String)]], Nothing]

    Permalink

    Use the given charset by default, unless specified otherwise in the response headers.

  12. def asParams: ResponseAs[Either[String, Seq[(String, String)]], Nothing]

    Permalink

    Use the utf-8 charset by default, unless specified otherwise in the response headers.

  13. def asStream[S]: ResponseAs[Either[String, S], S]

    Permalink
  14. def asStreamAlways[S]: ResponseAs[S, S]

    Permalink
  15. def asString(charset: String): ResponseAs[Either[String, String], Nothing]

    Permalink

    Use the given charset by default, unless specified otherwise in the response headers.

  16. def asString: ResponseAs[Either[String, String], Nothing]

    Permalink

    Use the utf-8 charset by default, unless specified otherwise in the response headers.

  17. def asStringAlways(charset: String): ResponseAs[String, Nothing]

    Permalink
  18. def asStringAlways: ResponseAs[String, Nothing]

    Permalink

    Use the utf-8 charset by default, unless specified otherwise in the response headers.

  19. val basicRequest: RequestT[Empty, Either[String, String], Nothing]

    Permalink

    A starting request, with the following modification comparing to emptyRequest: Accept-Encoding is set to gzip, deflate (compression/decompression is handled automatically by the library).

    A starting request, with the following modification comparing to emptyRequest: Accept-Encoding is set to gzip, deflate (compression/decompression is handled automatically by the library).

    Reads the response body as an Either[String, String], where Left is used if the status code is non-2xx, and Right otherwise.

  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  21. val emptyRequest: RequestT[Empty, Either[String, String], Nothing]

    Permalink

    An empty request with no headers.

    An empty request with no headers.

    Reads the response body as an Either[String, String], where Left is used if the status code is non-2xx, and Right otherwise.

  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. def fromMetadata[T, S](f: (ResponseMetadata) ⇒ ResponseAs[T, S]): ResponseAs[T, S]

    Permalink
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  26. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  27. def ignore: ResponseAs[Unit, Nothing]

    Permalink
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def multipart[B](name: String, b: B)(implicit arg0: BodySerializer[B]): Part[BasicRequestBody]

    Permalink

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

  30. def multipart(name: String, fs: Seq[(String, String)], encoding: String): Part[BasicRequestBody]

    Permalink

    Encodes the given parameters as form data.

    Encodes the given parameters as form data.

    Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.

  31. def multipart(name: String, fs: Seq[(String, String)]): Part[BasicRequestBody]

    Permalink

    Encodes the given parameters as form data using utf-8.

    Encodes the given parameters as form data using utf-8.

    Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.

  32. def multipart(name: String, fs: Map[String, String], encoding: String): Part[BasicRequestBody]

    Permalink

    Encodes the given parameters as form data.

    Encodes the given parameters as form data.

    Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.

  33. def multipart(name: String, fs: Map[String, String]): Part[BasicRequestBody]

    Permalink

    Encodes the given parameters as form data using utf-8.

    Encodes the given parameters as form data using utf-8.

    Content type will be set to application/x-www-form-urlencoded, can be overridden later using the contentType method.

  34. def multipart(name: String, data: InputStream): Part[BasicRequestBody]

    Permalink

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

  35. def multipart(name: String, data: ByteBuffer): Part[BasicRequestBody]

    Permalink

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

  36. def multipart(name: String, data: Array[Byte]): Part[BasicRequestBody]

    Permalink

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

  37. def multipart(name: String, data: String, encoding: String): Part[BasicRequestBody]

    Permalink

    Content type will be set to text/plain with utf-8 encoding, can be overridden later using the contentType method.

  38. def multipart(name: String, data: String): Part[BasicRequestBody]

    Permalink

    Content type will be set to text/plain with utf-8 encoding, can be overridden later using the contentType method.

  39. def multipartFile(name: String, file: File): Part[BasicRequestBody]

    Permalink

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

    Content type will be set to application/octet-stream, can be overridden later using the contentType method.

    File name will be set to the name of the file.

    Definition Classes
    SttpExtensions
  40. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  42. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  43. val quickRequest: RequestT[Empty, String, Nothing]

    Permalink

    A starting request which always reads the response body as a string, regardless of the status code.

  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  46. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from UriInterpolator

Inherited from SttpExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped