Class

play.api.libs.ws

WSClientConfig

Related Doc: package ws

Permalink

case class WSClientConfig(connectionTimeout: Duration = 2.minutes, idleTimeout: Duration = 2.minutes, requestTimeout: Duration = 2.minutes, followRedirects: Boolean = true, useProxyProperties: Boolean = true, userAgent: Option[String] = None, compressionEnabled: Boolean = false, ssl: SSLConfigSettings = SSLConfigSettings()) extends Product with Serializable

WS client config

connectionTimeout

The maximum time to wait when connecting to the remote host (default is 120 seconds).

idleTimeout

The maximum time the request can stay idle (connection is established but waiting for more data) (default is 120 seconds).

requestTimeout

The total time you accept a request to take (it will be interrupted even if the remote host is still sending data) (default is 120 seconds).

followRedirects

Configures the client to follow 301 and 302 redirects (default is true).

useProxyProperties

To use the JVM system’s HTTP proxy settings (http.proxyHost, http.proxyPort) (default is true).

userAgent

To configure the User-Agent header field (default is None).

compressionEnabled

Set it to true to use gzip/deflater encoding (default is false).

ssl

use custom SSL / TLS configuration, see https://typesafehub.github.io/ssl-config/ for documentation.

Source
WSClientConfig.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WSClientConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WSClientConfig(connectionTimeout: Duration = 2.minutes, idleTimeout: Duration = 2.minutes, requestTimeout: Duration = 2.minutes, followRedirects: Boolean = true, useProxyProperties: Boolean = true, userAgent: Option[String] = None, compressionEnabled: Boolean = false, ssl: SSLConfigSettings = SSLConfigSettings())

    Permalink

    connectionTimeout

    The maximum time to wait when connecting to the remote host (default is 120 seconds).

    idleTimeout

    The maximum time the request can stay idle (connection is established but waiting for more data) (default is 120 seconds).

    requestTimeout

    The total time you accept a request to take (it will be interrupted even if the remote host is still sending data) (default is 120 seconds).

    followRedirects

    Configures the client to follow 301 and 302 redirects (default is true).

    useProxyProperties

    To use the JVM system’s HTTP proxy settings (http.proxyHost, http.proxyPort) (default is true).

    userAgent

    To configure the User-Agent header field (default is None).

    compressionEnabled

    Set it to true to use gzip/deflater encoding (default is false).

    ssl

    use custom SSL / TLS configuration, see https://typesafehub.github.io/ssl-config/ for documentation.

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

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

  6. val compressionEnabled: Boolean

    Permalink

    Set it to true to use gzip/deflater encoding (default is false).

  7. val connectionTimeout: Duration

    Permalink

    The maximum time to wait when connecting to the remote host (default is 120 seconds).

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

    Permalink
    Definition Classes
    AnyRef

  9. def finalize(): Unit

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

  10. val followRedirects: Boolean

    Permalink

    Configures the client to follow 301 and 302 redirects (default is true).

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. val idleTimeout: Duration

    Permalink

    The maximum time the request can stay idle (connection is established but waiting for more data) (default is 120 seconds).

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. val requestTimeout: Duration

    Permalink

    The total time you accept a request to take (it will be interrupted even if the remote host is still sending data) (default is 120 seconds).

  18. val ssl: SSLConfigSettings

    Permalink

    use custom SSL / TLS configuration, see https://typesafehub.github.io/ssl-config/ for documentation.

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

    Permalink
    Definition Classes
    AnyRef

  20. val useProxyProperties: Boolean

    Permalink

    To use the JVM system’s HTTP proxy settings (http.proxyHost, http.proxyPort) (default is true).

  21. val userAgent: Option[String]

    Permalink

    To configure the User-Agent header field (default is None).

  22. final def wait(): Unit

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

  23. final def wait(arg0: Long, arg1: Int): Unit

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

  24. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped