Class CachingWebClientOptions

Hierarchy

WebClientOptions
- CachingWebClientOptions

Index

Constructors

constructor

Methods

Constructors

constructor

new CachingWebClientOptions(): CachingWebClientOptions
new CachingWebClientOptions(obj: CachingWebClientOptions | {}): CachingWebClientOptions

Overrides WebClientOptions.constructor
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:33
Returns CachingWebClientOptions
Overrides WebClientOptions.constructor
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:35
Parameters
- obj: CachingWebClientOptions | {}
Returns CachingWebClientOptions

Methods

addCachedMethod

addCachedMethod(cachedMethods: HttpMethod): CachingWebClientOptions

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:60
Configure the HTTP methods that can be cached.

Parameters
- cachedMethods: HttpMethod
Returns CachingWebClientOptions

addCachedStatusCode

addCachedStatusCode(cachedStatusCodes: number): CachingWebClientOptions

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:75
Configure the status codes that can be cached.

Parameters
- cachedStatusCodes: number
Returns CachingWebClientOptions

addCrlPath

addCrlPath(crlPaths: string): CachingWebClientOptions

Overrides WebClientOptions.addCrlPath
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:83
Parameters
- crlPaths: string
Returns CachingWebClientOptions

addCrlValue

addCrlValue(crlValues: Buffer): CachingWebClientOptions

Overrides WebClientOptions.addCrlValue
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:87
Parameters
- crlValues: Buffer
Returns CachingWebClientOptions

addEnabledCipherSuite

addEnabledCipherSuite(enabledCipherSuites: string): CachingWebClientOptions

Overrides WebClientOptions.addEnabledCipherSuite
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:108
Parameters
- enabledCipherSuites: string
Returns CachingWebClientOptions

addEnabledSecureTransportProtocol

addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): CachingWebClientOptions

Overrides WebClientOptions.addEnabledSecureTransportProtocol
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:114
Parameters
- enabledSecureTransportProtocols: string
Returns CachingWebClientOptions

addNonProxyHost

addNonProxyHost(nonProxyHosts: string): CachingWebClientOptions

Overrides WebClientOptions.addNonProxyHost
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:240
Parameters
- nonProxyHosts: string
Returns CachingWebClientOptions

getActivityLogDataFormat

getActivityLogDataFormat(): any

Overrides WebClientOptions.getActivityLogDataFormat
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:39
Returns any

getAlpnVersions

getAlpnVersions(): HttpVersion[]

Overrides WebClientOptions.getAlpnVersions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:43
Returns HttpVersion[]

getCachedMethods

getCachedMethods(): HttpMethod[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:50
Configure the HTTP methods that can be cached.

Returns HttpMethod[]

getCachedStatusCodes

getCachedStatusCodes(): number[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:65
Configure the status codes that can be cached.

Returns number[]

getConnectTimeout

getConnectTimeout(): number

Overrides WebClientOptions.getConnectTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:77
Returns number

getCrlPaths

getCrlPaths(): string[]

Overrides WebClientOptions.getCrlPaths
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:81
Returns string[]

getCrlValues

getCrlValues(): Buffer[]

Overrides WebClientOptions.getCrlValues
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:85
Returns Buffer[]

getDecoderInitialBufferSize

getDecoderInitialBufferSize(): number

Overrides WebClientOptions.getDecoderInitialBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:89
Returns number

getDefaultHost

getDefaultHost(): string

Overrides WebClientOptions.getDefaultHost
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:93
Returns string

getDefaultPort

getDefaultPort(): number

Overrides WebClientOptions.getDefaultPort
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:97
Returns number

getEnabledCipherSuites

getEnabledCipherSuites(): string[]

Overrides WebClientOptions.getEnabledCipherSuites
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:106
Returns string[]

getEnabledSecureTransportProtocols

getEnabledSecureTransportProtocols(): string[]

Overrides WebClientOptions.getEnabledSecureTransportProtocols
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:110
Returns string[]

getHttp2ConnectionWindowSize

getHttp2ConnectionWindowSize(): number

Overrides WebClientOptions.getHttp2ConnectionWindowSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:138
Returns number

getHttp2KeepAliveTimeout

getHttp2KeepAliveTimeout(): number

Overrides WebClientOptions.getHttp2KeepAliveTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:142
Returns number

getHttp2MaxPoolSize

getHttp2MaxPoolSize(): number

Overrides WebClientOptions.getHttp2MaxPoolSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:146
Returns number

getHttp2MultiplexingLimit

getHttp2MultiplexingLimit(): number

Overrides WebClientOptions.getHttp2MultiplexingLimit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:150
Returns number

getIdleTimeout

getIdleTimeout(): number

Overrides WebClientOptions.getIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:154
Returns number

getIdleTimeoutUnit

getIdleTimeoutUnit(): any

Overrides WebClientOptions.getIdleTimeoutUnit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:158
Returns any

getInitialSettings

getInitialSettings(): Http2Settings

Overrides WebClientOptions.getInitialSettings
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:162
Returns Http2Settings

getJdkSslEngineOptions

getJdkSslEngineOptions(): JdkSSLEngineOptions

Overrides WebClientOptions.getJdkSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:166
Returns JdkSSLEngineOptions

getKeepAliveTimeout

getKeepAliveTimeout(): number

Overrides WebClientOptions.getKeepAliveTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:174
Returns number

getKeyStoreOptions

getKeyStoreOptions(): JksOptions

Overrides WebClientOptions.getKeyStoreOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:180
Returns JksOptions

getLocalAddress

getLocalAddress(): string

Overrides WebClientOptions.getLocalAddress
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:184
Returns string

getLogActivity

getLogActivity(): boolean

Overrides WebClientOptions.getLogActivity
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:188
Returns boolean

getMaxChunkSize

getMaxChunkSize(): number

Overrides WebClientOptions.getMaxChunkSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:192
Returns number

getMaxHeaderSize

getMaxHeaderSize(): number

Overrides WebClientOptions.getMaxHeaderSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:196
Returns number

getMaxInitialLineLength

getMaxInitialLineLength(): number

Overrides WebClientOptions.getMaxInitialLineLength
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:200
Returns number

getMaxPoolSize

getMaxPoolSize(): number

Overrides WebClientOptions.getMaxPoolSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:204
Returns number

getMaxRedirects

getMaxRedirects(): number

Overrides WebClientOptions.getMaxRedirects
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:208
Returns number

getMaxWaitQueueSize

getMaxWaitQueueSize(): number

Overrides WebClientOptions.getMaxWaitQueueSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:212
Returns number

getMaxWebSocketFrameSize

getMaxWebSocketFrameSize(): number

Overrides WebClientOptions.getMaxWebSocketFrameSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:216
Returns number

getMaxWebSocketMessageSize

getMaxWebSocketMessageSize(): number

Overrides WebClientOptions.getMaxWebSocketMessageSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:220
Returns number

getMaxWebSockets

getMaxWebSockets(): number

Overrides WebClientOptions.getMaxWebSockets
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:224
Returns number

getMetricsName

getMetricsName(): string

Overrides WebClientOptions.getMetricsName
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:228
Returns string

getName

getName(): string

Overrides WebClientOptions.getName
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:232
Returns string

getNonProxyHosts

getNonProxyHosts(): string[]

Overrides WebClientOptions.getNonProxyHosts
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:236
Returns string[]

getOpenSslEngineOptions

getOpenSslEngineOptions(): OpenSSLEngineOptions

Overrides WebClientOptions.getOpenSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:242
Returns OpenSSLEngineOptions

getPemKeyCertOptions

getPemKeyCertOptions(): PemKeyCertOptions

Overrides WebClientOptions.getPemKeyCertOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:246
Returns PemKeyCertOptions

getPemTrustOptions

getPemTrustOptions(): PemTrustOptions

Overrides WebClientOptions.getPemTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:250
Returns PemTrustOptions

getPfxKeyCertOptions

getPfxKeyCertOptions(): PfxOptions

Overrides WebClientOptions.getPfxKeyCertOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:254
Returns PfxOptions

getPfxTrustOptions

getPfxTrustOptions(): PfxOptions

Overrides WebClientOptions.getPfxTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:258
Returns PfxOptions

getPipeliningLimit

getPipeliningLimit(): number

Overrides WebClientOptions.getPipeliningLimit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:266
Returns number

getPoolCleanerPeriod

getPoolCleanerPeriod(): number

Overrides WebClientOptions.getPoolCleanerPeriod
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:270
Returns number

getPoolEventLoopSize

getPoolEventLoopSize(): number

Overrides WebClientOptions.getPoolEventLoopSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:274
Returns number

getProtocolVersion

getProtocolVersion(): HttpVersion

Overrides WebClientOptions.getProtocolVersion
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:278
Returns HttpVersion

getProxyOptions

getProxyOptions(): ProxyOptions

Overrides WebClientOptions.getProxyOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:282
Returns ProxyOptions

getReadIdleTimeout

getReadIdleTimeout(): number

Overrides WebClientOptions.getReadIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:286
Returns number

getReceiveBufferSize

getReceiveBufferSize(): number

Overrides WebClientOptions.getReceiveBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:290
Returns number

getSendBufferSize

getSendBufferSize(): number

Overrides WebClientOptions.getSendBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:302
Returns number

getSoLinger

getSoLinger(): number

Overrides WebClientOptions.getSoLinger
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:314
Returns number

getSslEngineOptions

getSslEngineOptions(): any

Overrides WebClientOptions.getSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:322
Returns any

getSslHandshakeTimeout

getSslHandshakeTimeout(): number

Overrides WebClientOptions.getSslHandshakeTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:326
Returns number

getSslHandshakeTimeoutUnit

getSslHandshakeTimeoutUnit(): any

Overrides WebClientOptions.getSslHandshakeTimeoutUnit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:330
Returns any

getTcpUserTimeout

getTcpUserTimeout(): number

Overrides WebClientOptions.getTcpUserTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:354
Returns number

getTemplateExpandOptions

getTemplateExpandOptions(): ExpandOptions

Overrides WebClientOptions.getTemplateExpandOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:358
Returns ExpandOptions

getTracingPolicy

getTracingPolicy(): TracingPolicy

Overrides WebClientOptions.getTracingPolicy
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:362
Returns TracingPolicy

getTrafficClass

getTrafficClass(): number

Overrides WebClientOptions.getTrafficClass
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:366
Returns number

getTrustOptions

getTrustOptions(): any

Overrides WebClientOptions.getTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:374
Returns any

getTrustStoreOptions

getTrustStoreOptions(): JksOptions

Overrides WebClientOptions.getTrustStoreOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:378
Returns JksOptions

getTryUsePerMessageWebSocketCompression

getTryUsePerMessageWebSocketCompression(): boolean

Overrides WebClientOptions.getTryUsePerMessageWebSocketCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:388
Returns boolean

getTryWebSocketDeflateFrameCompression

getTryWebSocketDeflateFrameCompression(): boolean

Overrides WebClientOptions.getTryWebSocketDeflateFrameCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:392
Returns boolean

getUserAgent

getUserAgent(): string

Overrides WebClientOptions.getUserAgent
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:401
Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

Returns string

getWebSocketClosingTimeout

getWebSocketClosingTimeout(): number

Overrides WebClientOptions.getWebSocketClosingTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:426
Returns number

getWebSocketCompressionAllowClientNoContext

getWebSocketCompressionAllowClientNoContext(): boolean

Overrides WebClientOptions.getWebSocketCompressionAllowClientNoContext
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:430
Returns boolean

getWebSocketCompressionLevel

getWebSocketCompressionLevel(): number

Overrides WebClientOptions.getWebSocketCompressionLevel
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:434
Returns number

getWebSocketCompressionRequestServerNoContext

getWebSocketCompressionRequestServerNoContext(): boolean

Overrides WebClientOptions.getWebSocketCompressionRequestServerNoContext
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:438
Returns boolean

getWriteIdleTimeout

getWriteIdleTimeout(): number

Overrides WebClientOptions.getWriteIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:442
Returns number

isFollowRedirects

isFollowRedirects(): boolean

Overrides WebClientOptions.isFollowRedirects
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:119
Configure the default behavior of the client to follow HTTP 30x redirections.

Returns boolean

isForceSni

isForceSni(): boolean

Overrides WebClientOptions.isForceSni
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:126
Returns boolean

isHttp2ClearTextUpgrade

isHttp2ClearTextUpgrade(): boolean

Overrides WebClientOptions.isHttp2ClearTextUpgrade
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:130
Returns boolean

isHttp2ClearTextUpgradeWithPreflightRequest

isHttp2ClearTextUpgradeWithPreflightRequest(): boolean

Overrides WebClientOptions.isHttp2ClearTextUpgradeWithPreflightRequest
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:134
Returns boolean

isKeepAlive

isKeepAlive(): boolean

Overrides WebClientOptions.isKeepAlive
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:170
Returns boolean

isPipelining

isPipelining(): boolean

Overrides WebClientOptions.isPipelining
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:262
Returns boolean

isReuseAddress

isReuseAddress(): boolean

Overrides WebClientOptions.isReuseAddress
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:294
Returns boolean

isReusePort

isReusePort(): boolean

Overrides WebClientOptions.isReusePort
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:298
Returns boolean

isSendUnmaskedFrames

isSendUnmaskedFrames(): boolean

Overrides WebClientOptions.isSendUnmaskedFrames
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:306
Returns boolean

isShared

isShared(): boolean

Overrides WebClientOptions.isShared
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:310
Returns boolean

isSsl

isSsl(): boolean

Overrides WebClientOptions.isSsl
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:318
Returns boolean

isTcpCork

isTcpCork(): boolean

Overrides WebClientOptions.isTcpCork
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:334
Returns boolean

isTcpFastOpen

isTcpFastOpen(): boolean

Overrides WebClientOptions.isTcpFastOpen
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:338
Returns boolean

isTcpKeepAlive

isTcpKeepAlive(): boolean

Overrides WebClientOptions.isTcpKeepAlive
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:342
Returns boolean

isTcpNoDelay

isTcpNoDelay(): boolean

Overrides WebClientOptions.isTcpNoDelay
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:346
Returns boolean

isTcpQuickAck

isTcpQuickAck(): boolean

Overrides WebClientOptions.isTcpQuickAck
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:350
Returns boolean

isTrustAll

isTrustAll(): boolean

Overrides WebClientOptions.isTrustAll
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:370
Returns boolean

isTryUseCompression

isTryUseCompression(): boolean

Overrides WebClientOptions.isTryUseCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:382
Returns boolean

isUseAlpn

isUseAlpn(): boolean

Overrides WebClientOptions.isUseAlpn
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:394
Returns boolean

isUserAgentEnabled

isUserAgentEnabled(): boolean

Overrides WebClientOptions.isUserAgentEnabled
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:411
Sets whether the Web Client should send a user agent header. Defaults to true.

Returns boolean

isVaryCachingEnabled

isVaryCachingEnabled(): boolean

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:420
Returns boolean

isVerifyHost

isVerifyHost(): boolean

Overrides WebClientOptions.isVerifyHost
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:422
Returns boolean

setActivityLogDataFormat

setActivityLogDataFormat(activityLogDataFormat: any): CachingWebClientOptions

Overrides WebClientOptions.setActivityLogDataFormat
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:41
Parameters
- activityLogDataFormat: any
Returns CachingWebClientOptions

setAlpnVersions

setAlpnVersions(alpnVersions: HttpVersion[]): CachingWebClientOptions

Overrides WebClientOptions.setAlpnVersions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:45
Parameters
- alpnVersions: HttpVersion[]
Returns CachingWebClientOptions

setCachedMethods

setCachedMethods(cachedMethods: HttpMethod[]): CachingWebClientOptions

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:55
Configure the HTTP methods that can be cached.

Parameters
- cachedMethods: HttpMethod[]
Returns CachingWebClientOptions

setCachedStatusCodes

setCachedStatusCodes(cachedStatusCodes: number[]): CachingWebClientOptions

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:70
Configure the status codes that can be cached.

Parameters
- cachedStatusCodes: number[]
Returns CachingWebClientOptions

setConnectTimeout

setConnectTimeout(connectTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setConnectTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:79
Parameters
- connectTimeout: number
Returns CachingWebClientOptions

setDecoderInitialBufferSize

setDecoderInitialBufferSize(decoderInitialBufferSize: number): CachingWebClientOptions

Overrides WebClientOptions.setDecoderInitialBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:91
Parameters
- decoderInitialBufferSize: number
Returns CachingWebClientOptions

setDefaultHost

setDefaultHost(defaultHost: string): CachingWebClientOptions

Overrides WebClientOptions.setDefaultHost
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:95
Parameters
- defaultHost: string
Returns CachingWebClientOptions

setDefaultPort

setDefaultPort(defaultPort: number): CachingWebClientOptions

Overrides WebClientOptions.setDefaultPort
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:99
Parameters
- defaultPort: number
Returns CachingWebClientOptions

setEnableVaryCaching

setEnableVaryCaching(enableVaryCaching: boolean): CachingWebClientOptions

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:104
Configure the client cache behavior for Vary responses.

Parameters
- enableVaryCaching: boolean
Returns CachingWebClientOptions

setEnabledSecureTransportProtocols

setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): CachingWebClientOptions

Overrides WebClientOptions.setEnabledSecureTransportProtocols
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:112
Parameters
- enabledSecureTransportProtocols: string[]
Returns CachingWebClientOptions

setFollowRedirects

setFollowRedirects(followRedirects: boolean): CachingWebClientOptions

Overrides WebClientOptions.setFollowRedirects
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:124
Configure the default behavior of the client to follow HTTP 30x redirections.

Parameters
- followRedirects: boolean
Returns CachingWebClientOptions

setForceSni

setForceSni(forceSni: boolean): CachingWebClientOptions

Overrides WebClientOptions.setForceSni
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:128
Parameters
- forceSni: boolean
Returns CachingWebClientOptions

setHttp2ClearTextUpgrade

setHttp2ClearTextUpgrade(http2ClearTextUpgrade: boolean): CachingWebClientOptions

Overrides WebClientOptions.setHttp2ClearTextUpgrade
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:132
Parameters
- http2ClearTextUpgrade: boolean
Returns CachingWebClientOptions

setHttp2ClearTextUpgradeWithPreflightRequest

setHttp2ClearTextUpgradeWithPreflightRequest(http2ClearTextUpgradeWithPreflightRequest: boolean): CachingWebClientOptions

Overrides WebClientOptions.setHttp2ClearTextUpgradeWithPreflightRequest
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:136
Parameters
- http2ClearTextUpgradeWithPreflightRequest: boolean
Returns CachingWebClientOptions

setHttp2ConnectionWindowSize

setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): CachingWebClientOptions

Overrides WebClientOptions.setHttp2ConnectionWindowSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:140
Parameters
- http2ConnectionWindowSize: number
Returns CachingWebClientOptions

setHttp2KeepAliveTimeout

setHttp2KeepAliveTimeout(http2KeepAliveTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setHttp2KeepAliveTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:144
Parameters
- http2KeepAliveTimeout: number
Returns CachingWebClientOptions

setHttp2MaxPoolSize

setHttp2MaxPoolSize(http2MaxPoolSize: number): CachingWebClientOptions

Overrides WebClientOptions.setHttp2MaxPoolSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:148
Parameters
- http2MaxPoolSize: number
Returns CachingWebClientOptions

setHttp2MultiplexingLimit

setHttp2MultiplexingLimit(http2MultiplexingLimit: number): CachingWebClientOptions

Overrides WebClientOptions.setHttp2MultiplexingLimit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:152
Parameters
- http2MultiplexingLimit: number
Returns CachingWebClientOptions

setIdleTimeout

setIdleTimeout(idleTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:156
Parameters
- idleTimeout: number
Returns CachingWebClientOptions

setIdleTimeoutUnit

setIdleTimeoutUnit(idleTimeoutUnit: any): CachingWebClientOptions

Overrides WebClientOptions.setIdleTimeoutUnit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:160
Parameters
- idleTimeoutUnit: any
Returns CachingWebClientOptions

setInitialSettings

setInitialSettings(initialSettings: Http2Settings): CachingWebClientOptions

Overrides WebClientOptions.setInitialSettings
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:164
Parameters
- initialSettings: Http2Settings
Returns CachingWebClientOptions

setJdkSslEngineOptions

setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): CachingWebClientOptions

Overrides WebClientOptions.setJdkSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:168
Parameters
- jdkSslEngineOptions: JdkSSLEngineOptions
Returns CachingWebClientOptions

setKeepAlive

setKeepAlive(keepAlive: boolean): CachingWebClientOptions

Overrides WebClientOptions.setKeepAlive
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:172
Parameters
- keepAlive: boolean
Returns CachingWebClientOptions

setKeepAliveTimeout

setKeepAliveTimeout(keepAliveTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setKeepAliveTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:176
Parameters
- keepAliveTimeout: number
Returns CachingWebClientOptions

setKeyCertOptions

setKeyCertOptions(keyCertOptions: any): CachingWebClientOptions

Overrides WebClientOptions.setKeyCertOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:178
Parameters
- keyCertOptions: any
Returns CachingWebClientOptions

setKeyStoreOptions

setKeyStoreOptions(keyStoreOptions: JksOptions): CachingWebClientOptions

Overrides WebClientOptions.setKeyStoreOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:182
Parameters
- keyStoreOptions: JksOptions
Returns CachingWebClientOptions

setLocalAddress

setLocalAddress(localAddress: string): CachingWebClientOptions

Overrides WebClientOptions.setLocalAddress
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:186
Parameters
- localAddress: string
Returns CachingWebClientOptions

setLogActivity

setLogActivity(logActivity: boolean): CachingWebClientOptions

Overrides WebClientOptions.setLogActivity
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:190
Parameters
- logActivity: boolean
Returns CachingWebClientOptions

setMaxChunkSize

setMaxChunkSize(maxChunkSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxChunkSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:194
Parameters
- maxChunkSize: number
Returns CachingWebClientOptions

setMaxHeaderSize

setMaxHeaderSize(maxHeaderSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxHeaderSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:198
Parameters
- maxHeaderSize: number
Returns CachingWebClientOptions

setMaxInitialLineLength

setMaxInitialLineLength(maxInitialLineLength: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxInitialLineLength
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:202
Parameters
- maxInitialLineLength: number
Returns CachingWebClientOptions

setMaxPoolSize

setMaxPoolSize(maxPoolSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxPoolSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:206
Parameters
- maxPoolSize: number
Returns CachingWebClientOptions

setMaxRedirects

setMaxRedirects(maxRedirects: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxRedirects
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:210
Parameters
- maxRedirects: number
Returns CachingWebClientOptions

setMaxWaitQueueSize

setMaxWaitQueueSize(maxWaitQueueSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxWaitQueueSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:214
Parameters
- maxWaitQueueSize: number
Returns CachingWebClientOptions

setMaxWebSocketFrameSize

setMaxWebSocketFrameSize(maxWebSocketFrameSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxWebSocketFrameSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:218
Parameters
- maxWebSocketFrameSize: number
Returns CachingWebClientOptions

setMaxWebSocketMessageSize

setMaxWebSocketMessageSize(maxWebSocketMessageSize: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxWebSocketMessageSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:222
Parameters
- maxWebSocketMessageSize: number
Returns CachingWebClientOptions

setMaxWebSockets

setMaxWebSockets(maxWebSockets: number): CachingWebClientOptions

Overrides WebClientOptions.setMaxWebSockets
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:226
Parameters
- maxWebSockets: number
Returns CachingWebClientOptions

setMetricsName

setMetricsName(metricsName: string): CachingWebClientOptions

Overrides WebClientOptions.setMetricsName
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:230
Parameters
- metricsName: string
Returns CachingWebClientOptions

setName

setName(name: string): CachingWebClientOptions

Overrides WebClientOptions.setName
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:234
Parameters
- name: string
Returns CachingWebClientOptions

setNonProxyHosts

setNonProxyHosts(nonProxyHosts: string[]): CachingWebClientOptions

Overrides WebClientOptions.setNonProxyHosts
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:238
Parameters
- nonProxyHosts: string[]
Returns CachingWebClientOptions

setOpenSslEngineOptions

setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): CachingWebClientOptions

Overrides WebClientOptions.setOpenSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:244
Parameters
- openSslEngineOptions: OpenSSLEngineOptions
Returns CachingWebClientOptions

setPemKeyCertOptions

setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): CachingWebClientOptions

Overrides WebClientOptions.setPemKeyCertOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:248
Parameters
- pemKeyCertOptions: PemKeyCertOptions
Returns CachingWebClientOptions

setPemTrustOptions

setPemTrustOptions(pemTrustOptions: PemTrustOptions): CachingWebClientOptions

Overrides WebClientOptions.setPemTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:252
Parameters
- pemTrustOptions: PemTrustOptions
Returns CachingWebClientOptions

setPfxKeyCertOptions

setPfxKeyCertOptions(pfxKeyCertOptions: PfxOptions): CachingWebClientOptions

Overrides WebClientOptions.setPfxKeyCertOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:256
Parameters
- pfxKeyCertOptions: PfxOptions
Returns CachingWebClientOptions

setPfxTrustOptions

setPfxTrustOptions(pfxTrustOptions: PfxOptions): CachingWebClientOptions

Overrides WebClientOptions.setPfxTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:260
Parameters
- pfxTrustOptions: PfxOptions
Returns CachingWebClientOptions

setPipelining

setPipelining(pipelining: boolean): CachingWebClientOptions

Overrides WebClientOptions.setPipelining
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:264
Parameters
- pipelining: boolean
Returns CachingWebClientOptions

setPipeliningLimit

setPipeliningLimit(pipeliningLimit: number): CachingWebClientOptions

Overrides WebClientOptions.setPipeliningLimit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:268
Parameters
- pipeliningLimit: number
Returns CachingWebClientOptions

setPoolCleanerPeriod

setPoolCleanerPeriod(poolCleanerPeriod: number): CachingWebClientOptions

Overrides WebClientOptions.setPoolCleanerPeriod
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:272
Parameters
- poolCleanerPeriod: number
Returns CachingWebClientOptions

setPoolEventLoopSize

setPoolEventLoopSize(poolEventLoopSize: number): CachingWebClientOptions

Overrides WebClientOptions.setPoolEventLoopSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:276
Parameters
- poolEventLoopSize: number
Returns CachingWebClientOptions

setProtocolVersion

setProtocolVersion(protocolVersion: HttpVersion): CachingWebClientOptions

Overrides WebClientOptions.setProtocolVersion
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:280
Parameters
- protocolVersion: HttpVersion
Returns CachingWebClientOptions

setProxyOptions

setProxyOptions(proxyOptions: ProxyOptions): CachingWebClientOptions

Overrides WebClientOptions.setProxyOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:284
Parameters
- proxyOptions: ProxyOptions
Returns CachingWebClientOptions

setReadIdleTimeout

setReadIdleTimeout(readIdleTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setReadIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:288
Parameters
- readIdleTimeout: number
Returns CachingWebClientOptions

setReceiveBufferSize

setReceiveBufferSize(receiveBufferSize: number): CachingWebClientOptions

Overrides WebClientOptions.setReceiveBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:292
Parameters
- receiveBufferSize: number
Returns CachingWebClientOptions

setReuseAddress

setReuseAddress(reuseAddress: boolean): CachingWebClientOptions

Overrides WebClientOptions.setReuseAddress
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:296
Parameters
- reuseAddress: boolean
Returns CachingWebClientOptions

setReusePort

setReusePort(reusePort: boolean): CachingWebClientOptions

Overrides WebClientOptions.setReusePort
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:300
Parameters
- reusePort: boolean
Returns CachingWebClientOptions

setSendBufferSize

setSendBufferSize(sendBufferSize: number): CachingWebClientOptions

Overrides WebClientOptions.setSendBufferSize
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:304
Parameters
- sendBufferSize: number
Returns CachingWebClientOptions

setSendUnmaskedFrames

setSendUnmaskedFrames(sendUnmaskedFrames: boolean): CachingWebClientOptions

Overrides WebClientOptions.setSendUnmaskedFrames
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:308
Parameters
- sendUnmaskedFrames: boolean
Returns CachingWebClientOptions

setShared

setShared(shared: boolean): CachingWebClientOptions

Overrides WebClientOptions.setShared
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:312
Parameters
- shared: boolean
Returns CachingWebClientOptions

setSoLinger

setSoLinger(soLinger: number): CachingWebClientOptions

Overrides WebClientOptions.setSoLinger
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:316
Parameters
- soLinger: number
Returns CachingWebClientOptions

setSsl

setSsl(ssl: boolean): CachingWebClientOptions

Overrides WebClientOptions.setSsl
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:320
Parameters
- ssl: boolean
Returns CachingWebClientOptions

setSslEngineOptions

setSslEngineOptions(sslEngineOptions: any): CachingWebClientOptions

Overrides WebClientOptions.setSslEngineOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:324
Parameters
- sslEngineOptions: any
Returns CachingWebClientOptions

setSslHandshakeTimeout

setSslHandshakeTimeout(sslHandshakeTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setSslHandshakeTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:328
Parameters
- sslHandshakeTimeout: number
Returns CachingWebClientOptions

setSslHandshakeTimeoutUnit

setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): CachingWebClientOptions

Overrides WebClientOptions.setSslHandshakeTimeoutUnit
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:332
Parameters
- sslHandshakeTimeoutUnit: any
Returns CachingWebClientOptions

setTcpCork

setTcpCork(tcpCork: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTcpCork
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:336
Parameters
- tcpCork: boolean
Returns CachingWebClientOptions

setTcpFastOpen

setTcpFastOpen(tcpFastOpen: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTcpFastOpen
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:340
Parameters
- tcpFastOpen: boolean
Returns CachingWebClientOptions

setTcpKeepAlive

setTcpKeepAlive(tcpKeepAlive: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTcpKeepAlive
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:344
Parameters
- tcpKeepAlive: boolean
Returns CachingWebClientOptions

setTcpNoDelay

setTcpNoDelay(tcpNoDelay: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTcpNoDelay
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:348
Parameters
- tcpNoDelay: boolean
Returns CachingWebClientOptions

setTcpQuickAck

setTcpQuickAck(tcpQuickAck: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTcpQuickAck
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:352
Parameters
- tcpQuickAck: boolean
Returns CachingWebClientOptions

setTcpUserTimeout

setTcpUserTimeout(tcpUserTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setTcpUserTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:356
Parameters
- tcpUserTimeout: number
Returns CachingWebClientOptions

setTemplateExpandOptions

setTemplateExpandOptions(templateExpandOptions: ExpandOptions): CachingWebClientOptions

Overrides WebClientOptions.setTemplateExpandOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:360
Parameters
- templateExpandOptions: ExpandOptions
Returns CachingWebClientOptions

setTracingPolicy

setTracingPolicy(tracingPolicy: TracingPolicy): CachingWebClientOptions

Overrides WebClientOptions.setTracingPolicy
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:364
Parameters
- tracingPolicy: TracingPolicy
Returns CachingWebClientOptions

setTrafficClass

setTrafficClass(trafficClass: number): CachingWebClientOptions

Overrides WebClientOptions.setTrafficClass
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:368
Parameters
- trafficClass: number
Returns CachingWebClientOptions

setTrustAll

setTrustAll(trustAll: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTrustAll
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:372
Parameters
- trustAll: boolean
Returns CachingWebClientOptions

setTrustOptions

setTrustOptions(trustOptions: any): CachingWebClientOptions

Overrides WebClientOptions.setTrustOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:376
Parameters
- trustOptions: any
Returns CachingWebClientOptions

setTrustStoreOptions

setTrustStoreOptions(trustStoreOptions: JksOptions): CachingWebClientOptions

Overrides WebClientOptions.setTrustStoreOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:380
Parameters
- trustStoreOptions: JksOptions
Returns CachingWebClientOptions

setTryUseCompression

setTryUseCompression(tryUseCompression: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTryUseCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:384
Parameters
- tryUseCompression: boolean
Returns CachingWebClientOptions

setTryUsePerFrameWebSocketCompression

setTryUsePerFrameWebSocketCompression(tryUsePerFrameWebSocketCompression: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTryUsePerFrameWebSocketCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:386
Parameters
- tryUsePerFrameWebSocketCompression: boolean
Returns CachingWebClientOptions

setTryUsePerMessageWebSocketCompression

setTryUsePerMessageWebSocketCompression(tryUsePerMessageWebSocketCompression: boolean): CachingWebClientOptions

Overrides WebClientOptions.setTryUsePerMessageWebSocketCompression
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:390
Parameters
- tryUsePerMessageWebSocketCompression: boolean
Returns CachingWebClientOptions

setUseAlpn

setUseAlpn(useAlpn: boolean): CachingWebClientOptions

Overrides WebClientOptions.setUseAlpn
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:396
Parameters
- useAlpn: boolean
Returns CachingWebClientOptions

setUserAgent

setUserAgent(userAgent: string): CachingWebClientOptions

Overrides WebClientOptions.setUserAgent
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:406
Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

Parameters
- userAgent: string
Returns CachingWebClientOptions

setUserAgentEnabled

setUserAgentEnabled(userAgentEnabled: boolean): CachingWebClientOptions

Overrides WebClientOptions.setUserAgentEnabled
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:416
Sets whether the Web Client should send a user agent header. Defaults to true.

Parameters
- userAgentEnabled: boolean
Returns CachingWebClientOptions

setVerifyHost

setVerifyHost(verifyHost: boolean): CachingWebClientOptions

Overrides WebClientOptions.setVerifyHost
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:424
Parameters
- verifyHost: boolean
Returns CachingWebClientOptions

setWebSocketClosingTimeout

setWebSocketClosingTimeout(webSocketClosingTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setWebSocketClosingTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:428
Parameters
- webSocketClosingTimeout: number
Returns CachingWebClientOptions

setWebSocketCompressionAllowClientNoContext

setWebSocketCompressionAllowClientNoContext(webSocketCompressionAllowClientNoContext: boolean): CachingWebClientOptions

Overrides WebClientOptions.setWebSocketCompressionAllowClientNoContext
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:432
Parameters
- webSocketCompressionAllowClientNoContext: boolean
Returns CachingWebClientOptions

setWebSocketCompressionLevel

setWebSocketCompressionLevel(webSocketCompressionLevel: number): CachingWebClientOptions

Overrides WebClientOptions.setWebSocketCompressionLevel
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:436
Parameters
- webSocketCompressionLevel: number
Returns CachingWebClientOptions

setWebSocketCompressionRequestServerNoContext

setWebSocketCompressionRequestServerNoContext(webSocketCompressionRequestServerNoContext: boolean): CachingWebClientOptions

Overrides WebClientOptions.setWebSocketCompressionRequestServerNoContext
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:440
Parameters
- webSocketCompressionRequestServerNoContext: boolean
Returns CachingWebClientOptions

setWriteIdleTimeout

setWriteIdleTimeout(writeIdleTimeout: number): CachingWebClientOptions

Overrides WebClientOptions.setWriteIdleTimeout
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:444
Parameters
- writeIdleTimeout: number
Returns CachingWebClientOptions

toJson

toJson(): {}

Overrides WebClientOptions.toJson
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:447
Returns {}
- [key: string]: any

Generated using TypeDoc