Packages

final case class ZClient[-Env, ReqEnv, -In, +Err, +Out](version: Version, url: URL, headers: Headers, sslConfig: Option[ClientSSLConfig], proxy: Option[Proxy], bodyEncoder: BodyEncoder[Env, Err, In], bodyDecoder: BodyDecoder[Env, Err, Out], driver: ZClient.Driver[Env, ReqEnv, Err]) extends HeaderOps[ZClient[Env, ReqEnv, In, Err, Out]] with Product with Serializable

Self Type
ZClient[Env, ReqEnv, In, Err, Out]
Linear Supertypes
Serializable, Product, Equals, HeaderOps[ZClient[Env, ReqEnv, In, Err, Out]], HeaderChecks[ZClient[Env, ReqEnv, In, Err, Out]], HeaderGetters, HeaderModifier[ZClient[Env, ReqEnv, In, Err, Out]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZClient
  2. Serializable
  3. Product
  4. Equals
  5. HeaderOps
  6. HeaderChecks
  7. HeaderGetters
  8. HeaderModifier
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ZClient(version: Version, url: URL, headers: Headers, sslConfig: Option[ClientSSLConfig], proxy: Option[Proxy], bodyEncoder: BodyEncoder[Env, Err, In], bodyDecoder: BodyDecoder[Env, Err, Out], driver: ZClient.Driver[Env, ReqEnv, Err])

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. def @@[LowerEnv <: UpperEnv, UpperEnv <: Env, LowerIn <: UpperIn, UpperIn <: In, LowerErr >: Err, UpperErr >: LowerErr, LowerOut >: Out, UpperOut >: LowerOut](aspect: ZClientAspect[LowerEnv, UpperEnv, LowerIn, UpperIn, LowerErr, UpperErr, LowerOut, UpperOut]): ZClient[UpperEnv, ReqEnv, UpperIn, LowerErr, LowerOut]

    Applies the specified client aspect, which can modify the execution of this client.

  5. final def addHeader[T](value: T)(implicit schema: Schema[T]): ZClient[Env, ReqEnv, In, Err, Out]

    Adds headers based on the given value.

    Adds headers based on the given value. The type of the value must have a schema and be a case class and all fields will be added as headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. The header names are the field names.

    Definition Classes
    HeaderModifier
  6. final def addHeader[T](name: String, value: T)(implicit schema: Schema[T]): ZClient[Env, ReqEnv, In, Err, Out]

    Adds a header / headers with the specified name and based on the given value.

    Adds a header / headers with the specified name and based on the given value. The value type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

    Definition Classes
    HeaderModifier
  7. def addHeader(name: CharSequence, value: CharSequence): ZClient[Env, ReqEnv, In, Err, Out]
    Attributes
    protected
    Definition Classes
    HeaderModifier
  8. final def addHeader(header: Header): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  9. final def addHeaders(headers: Iterable[(CharSequence, CharSequence)]): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  10. final def addHeaders(headers: Headers): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  11. def addLeadingSlash: ZClient[Env, ReqEnv, In, Err, Out]
  12. def addPath(path: Path): ZClient[Env, ReqEnv, In, Err, Out]
  13. def addPath(path: String): ZClient[Env, ReqEnv, In, Err, Out]
  14. def addQueryParam(key: String, value: String): ZClient[Env, ReqEnv, In, Err, Out]
  15. def addQueryParams(params: QueryParams): ZClient[Env, ReqEnv, In, Err, Out]
  16. def addTrailingSlash: ZClient[Env, ReqEnv, In, Err, Out]
  17. def addUrl(url: URL): ZClient[Env, ReqEnv, In, Err, Out]
  18. def apply(request: Request)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. def batched(implicit ev1: =:=[ReqEnv, Scope]): ZClient[Env, Any, In, Err, Out]

    Converts this streaming client into a batched client.

    Converts this streaming client into a batched client.

    NOTE: This client will materialize the responses into memory. If the response is streaming, it will await for it to be fully collected before resuming.

  21. def batched(request: Request)(implicit trace: Trace, ev1: =:=[ReqEnv, Scope], ev3: <:<[Body, In]): ZIO[Env, Err, Out]
  22. val bodyDecoder: BodyDecoder[Env, Err, Out]
  23. val bodyEncoder: BodyEncoder[Env, Err, In]
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  25. def contramap[In2](f: (In2) => In)(implicit trace: Trace): ZClient[Env, ReqEnv, In2, Err, Out]
  26. def contramapZIO[Err1 >: Err, In2](f: (In2) => IO[Err1, In]): ZClient[Env, ReqEnv, In2, Err1, Out]
  27. def delete(suffix: String)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  28. def dieOn(f: (Err) => Boolean)(implicit ev1: IsSubtypeOfError[Err, Throwable], ev2: CanFail[Err], trace: Trace): ZClient[Env, ReqEnv, In, Err, Out]
  29. val driver: ZClient.Driver[Env, ReqEnv, Err]
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def get(suffix: String)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  33. final def hasContentType(mediaType: MediaType): Boolean
    Definition Classes
    HeaderChecks
  34. final def hasContentType(value: CharSequence): Boolean
    Definition Classes
    HeaderChecks
  35. final def hasFormMultipartContentType: Boolean
    Definition Classes
    HeaderChecks
  36. final def hasFormUrlencodedContentType: Boolean
    Definition Classes
    HeaderChecks
  37. final def hasHeader(header: Header): Boolean
    Definition Classes
    HeaderChecks
  38. final def hasHeader(headerType: HeaderType): Boolean
    Definition Classes
    HeaderChecks
  39. final def hasHeader(name: CharSequence): Boolean
    Definition Classes
    HeaderChecks
  40. final def hasJsonContentType: Boolean
    Definition Classes
    HeaderChecks
  41. final def hasTextPlainContentType: Boolean
    Definition Classes
    HeaderChecks
  42. final def hasXhtmlXmlContentType: Boolean
    Definition Classes
    HeaderChecks
  43. final def hasXmlContentType: Boolean
    Definition Classes
    HeaderChecks
  44. def head(suffix: String)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  45. final def header[T](implicit schema: Schema[T]): Either[HeaderError, T]

    Retrieves headers as a value of the specified type.

    Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

    Definition Classes
    HeaderGetters
  46. final def header[T](name: String)(implicit schema: Schema[T]): Either[HeaderError, T]

    Retrieves the header with the specified name as a value of the specified type.

    Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

    Definition Classes
    HeaderGetters
  47. final def header(headerType: HeaderType): Option[HeaderValue]

    Gets a header or returns None if the header was not present or it could not be parsed

    Gets a header or returns None if the header was not present or it could not be parsed

    Definition Classes
    HeaderGetters
  48. final def headerOrElse[T](default: => T)(implicit schema: Schema[T]): T

    Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed.

    Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

    Definition Classes
    HeaderGetters
  49. final def headerOrElse[T](name: String, default: => T)(implicit schema: Schema[T]): T

    Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed.

    Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

    Definition Classes
    HeaderGetters
  50. final def headerOrFail(headerType: HeaderType): Option[Either[String, HeaderValue]]

    Gets a header.

    Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

    Definition Classes
    HeaderGetters
  51. final def headerZIO[T](name: String)(implicit schema: Schema[T]): IO[HeaderError, T]
    Definition Classes
    HeaderGetters
  52. final def headers(headerType: HeaderType): Chunk[HeaderValue]
    Definition Classes
    HeaderGetters
  53. val headers: Headers

    Returns the headers

    Returns the headers

    Definition Classes
    ZClient → HeaderGetters
  54. def host(host: String): ZClient[Env, ReqEnv, In, Err, Out]
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. def map[Out2](f: (Out) => Out2)(implicit trace: Trace): ZClient[Env, ReqEnv, In, Err, Out2]
  57. def mapError[Err2](f: (Err) => Err2): ZClient[Env, ReqEnv, In, Err2, Out]
  58. def mapZIO[Env1 <: Env, Err1 >: Err, Out2](f: (Out) => ZIO[Env1, Err1, Out2]): ZClient[Env1, ReqEnv, In, Err1, Out2]
  59. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  62. def patch(suffix: String)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  63. def path(path: Path): ZClient[Env, ReqEnv, In, Err, Out]
  64. def path(path: String): ZClient[Env, ReqEnv, In, Err, Out]
  65. def port(port: Int): ZClient[Env, ReqEnv, In, Err, Out]
  66. def post(suffix: String)(body: In)(implicit trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  67. def productElementNames: Iterator[String]
    Definition Classes
    Product
  68. def proxy(proxy: Proxy): ZClient[Env, ReqEnv, In, Err, Out]
  69. val proxy: Option[Proxy]
  70. def put(suffix: String)(body: In)(implicit trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  71. final def rawHeader(headerType: HeaderType): Option[String]

    Gets the raw unparsed header value

    Gets the raw unparsed header value

    Definition Classes
    HeaderGetters
  72. final def rawHeader(name: CharSequence): Option[String]

    Gets the raw unparsed header value

    Gets the raw unparsed header value

    Definition Classes
    HeaderGetters
  73. def rawHeaders(name: CharSequence): Chunk[String]
    Definition Classes
    HeaderGetters
  74. def refineOrDie[Err2](pf: PartialFunction[Err, Err2])(implicit ev1: IsSubtypeOfError[Err, Throwable], ev2: CanFail[Err], trace: Trace): ZClient[Env, ReqEnv, In, Err2, Out]
  75. final def removeHeader(name: String): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  76. final def removeHeader(headerType: HeaderType): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  77. final def removeHeaders(headers: Set[String]): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  78. def request(method: Method, suffix: String)(body: In)(implicit trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  79. def request(request: Request)(implicit ev: <:<[Body, In], trace: Trace): ZIO[zio.&[Env, ReqEnv], Err, Out]
  80. def retry[Env1 <: Env](policy: Schedule[Env1, Err, Any]): ZClient[Env1, ReqEnv, In, Err, Out]
  81. def scheme(scheme: Scheme): ZClient[Env, ReqEnv, In, Err, Out]
  82. final def setHeaders(headers: Headers): ZClient[Env, ReqEnv, In, Err, Out]
    Definition Classes
    HeaderModifier
  83. def socket[Env1 <: Env](app: WebSocketApp[Env1])(implicit trace: Trace, ev: =:=[ReqEnv, Scope]): ZIO[zio.&[Env1, ReqEnv], Err, Out]
  84. def ssl(ssl: ClientSSLConfig): ZClient[Env, ReqEnv, In, Err, Out]
  85. val sslConfig: Option[ClientSSLConfig]
  86. def stream[R, E0 >: Err, A](request: Request)(f: (Out) => ZStream[R, E0, A])(implicit trace: Trace, ev1: <:<[Body, In], ev2: =:=[ReqEnv, Scope]): ZStream[zio.&[R, Env], E0, A]

    Executes an HTTP request and transforms the response into a ZStream using the provided function

  87. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  88. def transform[Env2, S2, In2, Err2, Out2](bodyEncoder: BodyEncoder[Env2, Err2, In2], bodyDecoder: BodyDecoder[Env2, Err2, Out2], driver: ZClient.Driver[Env2, S2, Err2]): ZClient[Env2, S2, In2, Err2, Out2]
  89. def updateHeaders(update: (Headers) => Headers)(implicit trace: Trace): ZClient[Env, ReqEnv, In, Err, Out]

    Updates the current Headers with new one, using the provided update function passed.

    Updates the current Headers with new one, using the provided update function passed.

    Definition Classes
    ZClient → HeaderModifier
  90. def updatePath(f: (Path) => Path): ZClient[Env, ReqEnv, In, Err, Out]
  91. def updateURL(f: (URL) => URL): ZClient[Env, ReqEnv, In, Err, Out]
  92. def uri(uri: URI): ZClient[Env, ReqEnv, In, Err, Out]
  93. def url(url: URL): ZClient[Env, ReqEnv, In, Err, Out]
  94. val url: URL
  95. val version: Version
  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  98. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def disableStreaming(implicit ev1: =:=[ReqEnv, Scope]): ZClient[Env, Any, In, Err, Out]
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) use batched instead

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HeaderOps[ZClient[Env, ReqEnv, In, Err, Out]]

Inherited from HeaderChecks[ZClient[Env, ReqEnv, In, Err, Out]]

Inherited from HeaderGetters

Inherited from HeaderModifier[ZClient[Env, ReqEnv, In, Err, Out]]

Inherited from AnyRef

Inherited from Any

Ungrouped