Packages

class Client extends RequestTypes with RequestBuilding

A REST client with a given base URL.

Linear Supertypes
RequestBuilding, RequestTypes, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. RequestBuilding
  3. RequestTypes
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Client(baseUrl: URL, charset: Charset = StandardCharsets.UTF_8)

Type Members

  1. sealed trait CanBuildRequest [T] extends AnyRef

    Represents evidence that the request can be built.

    Represents evidence that the request can be built. For requests that include content, this requires that an implicit content.Encoder is available for the given Content-Type.

    T

    request type

    Definition Classes
    RequestBuilding
    Annotations
    @implicitNotFound( ... )
  2. case class DeleteRequest [Accept <: Coproduct](url: URL, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Accept, Client.DeleteRequest[Accept]] with Product with Serializable
    Definition Classes
    RequestTypes
  3. case class FormPostRequest [Accept <: Coproduct, Elements <: Either[None.type, NonEmptyList[ValidatedNel[Throwable, FormElement]]]](url: URL, form: Elements = Left(None), multipart: Boolean = false, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Accept, Client.FormPostRequest[Accept, Elements]] with Product with Serializable
    Definition Classes
    RequestTypes
  4. case class GetRequest [Accept <: Coproduct](url: URL, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Accept, Client.GetRequest[Accept]] with Product with Serializable
    Definition Classes
    RequestTypes
  5. case class HeadRequest (url: URL, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Nothing, Client.HeadRequest] with Product with Serializable
    Definition Classes
    RequestTypes
  6. case class PostRequest [Content, ContentType, Accept <: Coproduct](url: URL, content: Content, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Accept, Client.PostRequest[Content, ContentType, Accept]] with Product with Serializable
    Definition Classes
    RequestTypes
  7. case class PutRequest [Content, ContentType, Accept <: Coproduct](url: URL, content: Content, headers: List[(String, String)] = List.empty, charset: Charset = StandardCharsets.UTF_8) extends Client.RequestSyntax[Accept, Client.PutRequest[Content, ContentType, Accept]] with Product with Serializable
    Definition Classes
    RequestTypes
  8. sealed trait RequestSyntax [Accept <: Coproduct, Self <: Client.RequestSyntax[Accept, Self]] extends AnyRef
    Definition Classes
    RequestTypes

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val client: com.twitter.finagle.Http.Client
    Attributes
    protected
  6. def clientTransform(client: com.twitter.finagle.Http.Client): com.twitter.finagle.Http.Client
    Attributes
    protected
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def close(): Unit

    Close this client releasing allocated resources.

  9. def delete(relativePath: String): DeleteRequest[:+:[String("*/*"), CNil]]

    Specify a DELETE request to be performed against the given resource

    Specify a DELETE request to be performed against the given resource

    relativePath

    The path to the resource, relative to the baseUrl

    returns

    A DeleteRequest object, which can further specify and send the request

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get(relativePath: String): GetRequest[:+:[String("*/*"), CNil]]

    Specify a GET request to be performed against the given resource

    Specify a GET request to be performed against the given resource

    relativePath

    The path to the resource, relative to the baseUrl

    returns

    A GetRequest object, which can further specify and send the request

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  16. def head(relativePath: String): HeadRequest

    Specify a HEAD request to be performed against the given resource

    Specify a HEAD request to be performed against the given resource

    relativePath

    The path to the resource, relative to the baseUrl

    returns

    A HeadRequest object, which can further specify and send the request

  17. val httpClient: Service[Request, Response]
    Attributes
    protected[featherbed]
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. def post(relativePath: String): PostRequest[None.type, Nothing, :+:[String("*/*"), CNil]]

    Specify a POST request to be performed against the given resource

    Specify a POST request to be performed against the given resource

    relativePath

    The path to the resource, relative to the baseUrl

    returns

    A PostRequest object, which can further specify and send the request

  23. def put(relativePath: String): PutRequest[None.type, Nothing, :+:[String("*/*"), CNil]]

    Specify a PUT request to be performed against the given resource

    Specify a PUT request to be performed against the given resource

    relativePath

    The path to the resource, relative to the baseUrl

    returns

    A PutRequest object, which can further specify and send the request

  24. def serviceTransform(service: Service[Request, Response]): Service[Request, Response]
    Attributes
    protected
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. object CanBuildRequest
    Definition Classes
    RequestBuilding

Inherited from RequestBuilding

Inherited from RequestTypes

Inherited from AnyRef

Inherited from Any

Ungrouped