Initializer
HttpClientOptions({HttpVersion*}? alpnVersions = null, Integer? connectTimeout = null, {String*}? crlPaths = null, String? defaultHost = null, Integer? defaultPort = null, {String*}? enabledCipherSuites = null, {String*}? enabledSecureTransportProtocols = null, Boolean? http2ClearTextUpgrade = null, Integer? http2ConnectionWindowSize = null, Integer? http2MaxPoolSize = null, Integer? http2MultiplexingLimit = null, Integer? idleTimeout = null, Http2Settings? initialSettings = null, JdkSSLEngineOptions? jdkSslEngineOptions = null, Boolean? keepAlive = null, JksOptions? keyStoreOptions = null, Boolean? logActivity = null, Integer? maxChunkSize = null, Integer? maxPoolSize = null, Integer? maxWaitQueueSize = null, Integer? maxWebsocketFrameSize = null, String? metricsName = null, OpenSSLEngineOptions? openSslEngineOptions = null, PemKeyCertOptions? pemKeyCertOptions = null, PemTrustOptions? pemTrustOptions = null, PfxOptions? pfxKeyCertOptions = null, PfxOptions? pfxTrustOptions = null, Boolean? pipelining = null, Integer? pipeliningLimit = null, HttpVersion? protocolVersion = null, ProxyOptions? proxyOptions = null, Integer? receiveBufferSize = null, Boolean? reuseAddress = null, Integer? sendBufferSize = null, Integer? soLinger = null, Boolean? ssl = null, Boolean? tcpKeepAlive = null, Boolean? tcpNoDelay = null, Integer? trafficClass = null, Boolean? trustAll = null, JksOptions? trustStoreOptions = null, Boolean? tryUseCompression = null, Boolean? useAlpn = null, Boolean? usePooledBuffers = null, Boolean? verifyHost = null)
Parameters:
  • alpnVersions = null

    Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to setProtocolVersion:

    • : [ "h2", "http/1.1" ]
    • otherwise: [[getProtocolVersion](../http/HttpClientOptions.type.html#getProtocolVersion)]
  • connectTimeout = null
  • crlPaths = null
  • defaultHost = null

    Set the default host name to be used by this client in requests if none is provided when making the request.

  • defaultPort = null

    Set the default port to be used by this client in requests if none is provided when making the request.

  • enabledCipherSuites = null
  • enabledSecureTransportProtocols = null
  • http2ClearTextUpgrade = null

    Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

  • http2ConnectionWindowSize = null

    Set the default HTTP/2 connection window size. It overrides the initial window size set by getInitialWindowSize, so the connection window size is greater than for its streams, in order the data throughput.

    A value of -1 reuses the initial window size setting.

  • http2MaxPoolSize = null

    Set the maximum pool size for HTTP/2 connections

  • http2MultiplexingLimit = null

    Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

    Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

  • idleTimeout = null
  • initialSettings = null

    Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

  • jdkSslEngineOptions = null
  • keepAlive = null

    Set whether keep alive is enabled on the client

  • keyStoreOptions = null
  • logActivity = null
  • maxChunkSize = null

    Set the maximum HTTP chunk size

  • maxPoolSize = null

    Set the maximum pool size for connections

  • maxWaitQueueSize = null

    Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

  • maxWebsocketFrameSize = null

    Set the max websocket frame size

  • metricsName = null
  • openSslEngineOptions = null
  • pemKeyCertOptions = null
  • pemTrustOptions = null
  • pfxKeyCertOptions = null
  • pfxTrustOptions = null
  • pipelining = null

    Set whether pipe-lining is enabled on the client

  • pipeliningLimit = null

    Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

  • protocolVersion = null

    Set the protocol version.

  • proxyOptions = null
  • receiveBufferSize = null
  • reuseAddress = null
  • sendBufferSize = null
  • soLinger = null
  • ssl = null
  • tcpKeepAlive = null
  • tcpNoDelay = null
  • trafficClass = null
  • trustAll = null
  • trustStoreOptions = null
  • tryUseCompression = null

    Set whether compression is enabled

  • useAlpn = null
  • usePooledBuffers = null
  • verifyHost = null

    Set whether hostname verification is enabled

Attributes
alpnVersionsshared {HttpVersion*}? alpnVersions

Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to setProtocolVersion:

  • : [ "h2", "http/1.1" ]
  • otherwise: [[getProtocolVersion](../http/HttpClientOptions.type.html#getProtocolVersion)]
defaultHostshared String? defaultHost

Set the default host name to be used by this client in requests if none is provided when making the request.

defaultPortshared Integer? defaultPort

Set the default port to be used by this client in requests if none is provided when making the request.

http2ClearTextUpgradeshared Boolean? http2ClearTextUpgrade

Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

http2ConnectionWindowSizeshared Integer? http2ConnectionWindowSize

Set the default HTTP/2 connection window size. It overrides the initial window size set by getInitialWindowSize, so the connection window size is greater than for its streams, in order the data throughput.

A value of -1 reuses the initial window size setting.

http2MaxPoolSizeshared Integer? http2MaxPoolSize

Set the maximum pool size for HTTP/2 connections

http2MultiplexingLimitshared Integer? http2MultiplexingLimit

Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

initialSettingsshared Http2Settings? initialSettings

Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

keepAliveshared Boolean? keepAlive

Set whether keep alive is enabled on the client

maxChunkSizeshared Integer? maxChunkSize

Set the maximum HTTP chunk size

maxPoolSizeshared Integer? maxPoolSize

Set the maximum pool size for connections

maxWaitQueueSizeshared Integer? maxWaitQueueSize

Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

maxWebsocketFrameSizeshared Integer? maxWebsocketFrameSize

Set the max websocket frame size

pipeliningshared Boolean? pipelining

Set whether pipe-lining is enabled on the client

pipeliningLimitshared Integer? pipeliningLimit

Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

protocolVersionshared HttpVersion? protocolVersion

Set the protocol version.

tryUseCompressionshared Boolean? tryUseCompression

Set whether compression is enabled

verifyHostshared Boolean? verifyHost

Set whether hostname verification is enabled

Inherited Attributes
Attributes inherited from: ClientOptionsBase
Attributes inherited from: NetworkOptions
Attributes inherited from: Object
hash, string
Attributes inherited from: TCPSSLOptions
Methods
toJsonshared actual default JsonObject toJson()
Refines ClientOptionsBase.toJson ultimately refines BaseDataObject.toJson
Inherited Methods
Methods inherited from: ClientOptionsBase
Methods inherited from: NetworkOptions
Methods inherited from: Object
equals
Methods inherited from: TCPSSLOptions
Methods inherited from: BaseDataObject
toJson