case class Req(run: (RequestBuilder) => RequestBuilder, props: Properties = Req.Properties()) extends MethodVerbs with UrlVerbs with ParamVerbs with AuthVerbs with HeaderVerbs with RequestBuilderVerbs with Product with Serializable

This wrapper provides referential transparency for the underlying RequestBuilder.

Linear Supertypes
Serializable, Product, Equals, RequestBuilderVerbs, HeaderVerbs, AuthVerbs, ParamVerbs, UrlVerbs, MethodVerbs, RequestVerbs, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Req
  2. Serializable
  3. Product
  4. Equals
  5. RequestBuilderVerbs
  6. HeaderVerbs
  7. AuthVerbs
  8. ParamVerbs
  9. UrlVerbs
  10. MethodVerbs
  11. RequestVerbs
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Req(run: (RequestBuilder) => RequestBuilder, props: Properties = Req.Properties())

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def /(segment: AnyVal): Req

    Append a segment to the URL using the toString method of the provided segment.

    Append a segment to the URL using the toString method of the provided segment.

    Definition Classes
    UrlVerbs
  4. def /(segment: String): Req

    Append a segment to the URL.

    Append a segment to the URL.

    Definition Classes
    UrlVerbs
  5. def /?(segmentOpt: Option[String]): Req

    Append a segment that may or may not occur to the URL.

    Append a segment that may or may not occur to the URL.

    Definition Classes
    UrlVerbs
  6. def <:<(hs: Iterable[(String, String)]): Req

    Append a collecton of headers to the headers already on the request.

    Append a collecton of headers to the headers already on the request.

    Definition Classes
    HeaderVerbs
  7. def <<(body: String): Req

    Set request body to a given string,

    Set request body to a given string,

    • set method to POST unless explicitly set otherwise
    • set HTTP Content-Type to "text/plain; charset=UTF-8" if unspecified.
    Definition Classes
    ParamVerbs
  8. def <<(params: Iterable[(String, String)]): Req

    Adds params to the request body.

    Adds params to the request body. Sets request method to POST unless it has been explicitly set.

    Definition Classes
    ParamVerbs
  9. def <<<(file: File): Req

    Set a file as the request body and set method to PUT if it's not explicitly set.

    Set a file as the request body and set method to PUT if it's not explicitly set.

    Definition Classes
    ParamVerbs
  10. def <<?(params: Iterable[(String, String)]): Req

    Adds params as query parameters

    Adds params as query parameters

    Definition Classes
    ParamVerbs
  11. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def DELETE: Req
    Definition Classes
    MethodVerbs
  13. def GET: Req
    Definition Classes
    MethodVerbs
  14. def HEAD: Req
    Definition Classes
    MethodVerbs
  15. def OPTIONS: Req
    Definition Classes
    MethodVerbs
  16. def PATCH: Req
    Definition Classes
    MethodVerbs
  17. def POST: Req
    Definition Classes
    MethodVerbs
  18. def PUT: Req
    Definition Classes
    MethodVerbs
  19. def TRACE: Req
    Definition Classes
    MethodVerbs
  20. def addBodyPart(part: Part): Req

    Add a new body part to the request.

    Add a new body part to the request.

    Definition Classes
    RequestBuilderVerbs
  21. def addCookie(cookie: Cookie): Req

    Add a new cookie to the request.

    Add a new cookie to the request.

    Definition Classes
    RequestBuilderVerbs
  22. def addHeader(name: String, value: String): Req

    Add a new header to the request.

    Add a new header to the request.

    Definition Classes
    RequestBuilderVerbs
  23. def addOrReplaceCookie(cookie: Cookie): Req

    Add ore replace a cookie

    Add ore replace a cookie

    Definition Classes
    RequestBuilderVerbs
  24. def addParameter(key: String, value: String): Req

    Add a new body parameter to the request.

    Add a new body parameter to the request.

    Definition Classes
    RequestBuilderVerbs
  25. def addQueryParameter(name: String, value: String): Req

    Add a new query parameter to the request.

    Add a new query parameter to the request.

    Definition Classes
    RequestBuilderVerbs
  26. def appendBodyParams(params: Iterable[(String, String)]): Req

    Adds params to the request body.

    Adds params to the request body. Sets request method to POST unless it has been explicitly set.

    Definition Classes
    ParamVerbs
  27. def appendHeaders(hs: Iterable[(String, String)]): Req

    Append a collecton of headers to the headers already on the request.

    Append a collecton of headers to the headers already on the request.

    Definition Classes
    HeaderVerbs
  28. def appendOptionalSegment(segmentOpt: Option[String]): Req

    Append a segment that may or may not occur to the URL.

    Append a segment that may or may not occur to the URL.

    Definition Classes
    UrlVerbs
  29. def appendQueryParams(params: Iterable[(String, String)]): Req

    Adds params as query parameters

    Adds params as query parameters

    Definition Classes
    ParamVerbs
  30. def appendSegment(segment: AnyVal): Req

    Append a segment to the URL using the toString method of the provided segment.

    Append a segment to the URL using the toString method of the provided segment.

    Definition Classes
    UrlVerbs
  31. def appendSegment(segment: String): Req

    Append a segment to the URL.

    Append a segment to the URL.

    Definition Classes
    UrlVerbs
  32. def as(realm: Realm): Req
    Definition Classes
    AuthVerbs
  33. def as(user: String, password: String, scheme: AuthScheme): Req
    Definition Classes
    AuthVerbs
  34. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  35. def as_!(user: String, password: String): Req

    Basic auth, use with care.

    Basic auth, use with care.

    Definition Classes
    AuthVerbs
  36. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def implyMethod(method: String): Req

    Set method unless method has been explicitly set using setMethod.

    Set method unless method has been explicitly set using setMethod.

    Definition Classes
    RequestBuilderVerbs
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. def productElementNames: Iterator[String]
    Definition Classes
    Product
  46. val props: Properties
  47. val run: (RequestBuilder) => RequestBuilder
  48. def secure: Req

    Ensure the request is using the https scheme.

    Ensure the request is using the https scheme.

    Definition Classes
    UrlVerbs
  49. def setBody(file: File): Req

    Set the request body to the contents of a File.

    Set the request body to the contents of a File.

    Definition Classes
    RequestBuilderVerbs
  50. def setBody(data: String): Req

    Set the request body using a string.

    Set the request body using a string.

    Definition Classes
    RequestBuilderVerbs
  51. def setBody(dataWriter: BodyGenerator): Req

    Set the request body using a BodyGenerator.

    Set the request body using a BodyGenerator.

    Definition Classes
    RequestBuilderVerbs
  52. def setBody(dataWriter: BodyGenerator, length: Long): Req

    Set the request body using a BodyGenerator and length.

    Set the request body using a BodyGenerator and length.

    Definition Classes
    RequestBuilderVerbs
  53. def setBody(data: Array[Byte]): Req

    Set the request body from a byte array.

    Set the request body from a byte array.

    Definition Classes
    RequestBuilderVerbs
  54. def setBodyEncoding(charset: Charset): Req

    Set the body encoding to the specified charset.

    Set the body encoding to the specified charset.

    Definition Classes
    RequestBuilderVerbs
  55. def setContentType(mediaType: String, charset: Charset): Req

    Set the content type and charset for the request.

    Set the content type and charset for the request.

    Definition Classes
    RequestBuilderVerbs
  56. def setFileBody(file: File): Req

    Set a file as the request body and set method to PUT if it's not explicitly set.

    Set a file as the request body and set method to PUT if it's not explicitly set.

    Definition Classes
    ParamVerbs
  57. def setFollowRedirects(followRedirects: Boolean): Req

    Set the follow redirects setting

    Set the follow redirects setting

    Definition Classes
    RequestBuilderVerbs
  58. def setHeader(name: String, value: String): Req

    Set a header

    Set a header

    Definition Classes
    RequestBuilderVerbs
  59. def setHeaders(headers: Map[String, Seq[String]]): Req

    Set multiple headers

    Set multiple headers

    Definition Classes
    RequestBuilderVerbs
  60. def setMethod(method: String): Req

    Explicitly set the method of the request.

    Explicitly set the method of the request.

    Definition Classes
    RequestBuilderVerbs
  61. def setParameters(parameters: Map[String, Seq[String]]): Req

    Set form parameters

    Set form parameters

    Definition Classes
    RequestBuilderVerbs
  62. def setProxyServer(proxyServer: ProxyServer): Req

    Set the proxy server for the request

    Set the proxy server for the request

    Definition Classes
    RequestBuilderVerbs
  63. def setQueryParameters(params: Map[String, Seq[String]]): Req

    Set query parameters, overwriting any pre-existing query parameters.

    Set query parameters, overwriting any pre-existing query parameters.

    Definition Classes
    RequestBuilderVerbs
  64. def setRealm(realm: Realm): Req

    Set auth realm

    Set auth realm

    Definition Classes
    RequestBuilderVerbs
  65. def setStringBody(body: String): Req

    Set request body to a given string,

    Set request body to a given string,

    • set method to POST unless explicitly set otherwise
    • set HTTP Content-Type to "text/plain; charset=UTF-8" if unspecified.
    Definition Classes
    ParamVerbs
  66. def setUrl(url: String): Req

    Set the url of the request.

    Set the url of the request.

    Definition Classes
    RequestBuilderVerbs
  67. def setVirtualHost(virtualHost: String): Req

    Set the virual hostname

    Set the virual hostname

    Definition Classes
    RequestBuilderVerbs
  68. def subject: Req
    Definition Classes
    Req → RequestVerbs
  69. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  70. def toRequest: Request

    Convert this to a concrete request.

  71. def toRequestBuilder: RequestBuilder

    Convert this to a concrete RequestBuilder setting the Content-Type for String bodies if not already set.

  72. def underlying(nextReq: (RequestBuilder) => RequestBuilder, nextProps: (Properties) => Properties): Req

    Append a transform onto the underlying AHC RequestBuilder and simultaniously transform the Req.Properties.

  73. def underlying(next: (RequestBuilder) => RequestBuilder): Req

    Append a transform onto the underlying AHC RequestBuilder.

  74. def url: String

    Retrieve the fully materialized URL.

    Retrieve the fully materialized URL.

    Definition Classes
    UrlVerbs
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RequestBuilderVerbs

Inherited from HeaderVerbs

Inherited from AuthVerbs

Inherited from ParamVerbs

Inherited from UrlVerbs

Inherited from MethodVerbs

Inherited from RequestVerbs

Inherited from AnyRef

Inherited from Any

Ungrouped