Class WebClientOptions

Hierarchy

any
- WebClientOptions
  - CachingWebClientOptions

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:488
Returns WebClientOptions
- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:490
Parameters
- obj: WebClientOptions | {}
Returns WebClientOptions

Methods

addCrlPath

addCrlPath(crlPaths: string): WebClientOptions

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

addCrlValue

addCrlValue(crlValues: Buffer): WebClientOptions

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

addEnabledCipherSuite

addEnabledCipherSuite(enabledCipherSuites: string): WebClientOptions

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

addEnabledSecureTransportProtocol

addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): WebClientOptions

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

addNonProxyHost

addNonProxyHost(nonProxyHosts: string): WebClientOptions

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

getActivityLogDataFormat

getActivityLogDataFormat(): any

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

getAlpnVersions

getAlpnVersions(): HttpVersion[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:498
Returns HttpVersion[]

getConnectTimeout

getConnectTimeout(): number

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

getCrlPaths

getCrlPaths(): string[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:506
Returns string[]

getCrlValues

getCrlValues(): Buffer[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:510
Returns Buffer[]

getDecoderInitialBufferSize

getDecoderInitialBufferSize(): number

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

getDefaultHost

getDefaultHost(): string

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

getDefaultPort

getDefaultPort(): number

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

getEnabledCipherSuites

getEnabledCipherSuites(): string[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:526
Returns string[]

getEnabledSecureTransportProtocols

getEnabledSecureTransportProtocols(): string[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:530
Returns string[]

getHttp2ConnectionWindowSize

getHttp2ConnectionWindowSize(): number

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

getHttp2KeepAliveTimeout

getHttp2KeepAliveTimeout(): number

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

getHttp2MaxPoolSize

getHttp2MaxPoolSize(): number

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

getHttp2MultiplexingLimit

getHttp2MultiplexingLimit(): number

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

getIdleTimeout

getIdleTimeout(): number

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

getIdleTimeoutUnit

getIdleTimeoutUnit(): any

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

getInitialSettings

getInitialSettings(): Http2Settings

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

getJdkSslEngineOptions

getJdkSslEngineOptions(): JdkSSLEngineOptions

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

getKeepAliveTimeout

getKeepAliveTimeout(): number

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

getKeyStoreOptions

getKeyStoreOptions(): JksOptions

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

getLocalAddress

getLocalAddress(): string

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

getLogActivity

getLogActivity(): boolean

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

getMaxChunkSize

getMaxChunkSize(): number

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

getMaxHeaderSize

getMaxHeaderSize(): number

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

getMaxInitialLineLength

getMaxInitialLineLength(): number

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

getMaxPoolSize

getMaxPoolSize(): number

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

getMaxRedirects

getMaxRedirects(): number

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

getMaxWaitQueueSize

getMaxWaitQueueSize(): number

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

getMaxWebSocketFrameSize

getMaxWebSocketFrameSize(): number

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

getMaxWebSocketMessageSize

getMaxWebSocketMessageSize(): number

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

getMaxWebSockets

getMaxWebSockets(): number

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

getMetricsName

getMetricsName(): string

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

getName

getName(): string

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

getNonProxyHosts

getNonProxyHosts(): string[]

- Defined in io.vertx/vertx-web-client/target/npm/options.d.ts:656
Returns string[]

getOpenSslEngineOptions

getOpenSslEngineOptions(): OpenSSLEngineOptions

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

getPemKeyCertOptions

getPemKeyCertOptions(): PemKeyCertOptions

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

getPemTrustOptions

getPemTrustOptions(): PemTrustOptions

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

getPfxKeyCertOptions

getPfxKeyCertOptions(): PfxOptions

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

getPfxTrustOptions

getPfxTrustOptions(): PfxOptions

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

getPipeliningLimit

getPipeliningLimit(): number

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

getPoolCleanerPeriod

getPoolCleanerPeriod(): number

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

getPoolEventLoopSize

getPoolEventLoopSize(): number

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

getProtocolVersion

getProtocolVersion(): HttpVersion

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

getProxyOptions

getProxyOptions(): ProxyOptions

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

getReadIdleTimeout

getReadIdleTimeout(): number

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

getReceiveBufferSize

getReceiveBufferSize(): number

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

getSendBufferSize

getSendBufferSize(): number

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

getSoLinger

getSoLinger(): number

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

getSslEngineOptions

getSslEngineOptions(): any

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

getSslHandshakeTimeout

getSslHandshakeTimeout(): number

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

getSslHandshakeTimeoutUnit

getSslHandshakeTimeoutUnit(): any

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

getTcpUserTimeout

getTcpUserTimeout(): number

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

getTemplateExpandOptions

getTemplateExpandOptions(): ExpandOptions

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

getTracingPolicy

getTracingPolicy(): TracingPolicy

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

getTrafficClass

getTrafficClass(): number

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

getTrustOptions

getTrustOptions(): any

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

getTrustStoreOptions

getTrustStoreOptions(): JksOptions

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

getTryUsePerMessageWebSocketCompression

getTryUsePerMessageWebSocketCompression(): boolean

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

getTryWebSocketDeflateFrameCompression

getTryWebSocketDeflateFrameCompression(): boolean

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

getUserAgent

getUserAgent(): string

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

Returns string

getWebSocketClosingTimeout

getWebSocketClosingTimeout(): number

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

getWebSocketCompressionAllowClientNoContext

getWebSocketCompressionAllowClientNoContext(): boolean

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

getWebSocketCompressionLevel

getWebSocketCompressionLevel(): number

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

getWebSocketCompressionRequestServerNoContext

getWebSocketCompressionRequestServerNoContext(): boolean

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

getWriteIdleTimeout

getWriteIdleTimeout(): number

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

isFollowRedirects

isFollowRedirects(): boolean

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

Returns boolean

isForceSni

isForceSni(): boolean

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

isHttp2ClearTextUpgrade

isHttp2ClearTextUpgrade(): boolean

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

isHttp2ClearTextUpgradeWithPreflightRequest

isHttp2ClearTextUpgradeWithPreflightRequest(): boolean

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

isKeepAlive

isKeepAlive(): boolean

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

isPipelining

isPipelining(): boolean

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

isReuseAddress

isReuseAddress(): boolean

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

isReusePort

isReusePort(): boolean

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

isSendUnmaskedFrames

isSendUnmaskedFrames(): boolean

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

isShared

isShared(): boolean

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

isSsl

isSsl(): boolean

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

isTcpCork

isTcpCork(): boolean

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

isTcpFastOpen

isTcpFastOpen(): boolean

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

isTcpKeepAlive

isTcpKeepAlive(): boolean

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

isTcpNoDelay

isTcpNoDelay(): boolean

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

isTcpQuickAck

isTcpQuickAck(): boolean

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

isTrustAll

isTrustAll(): boolean

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

isTryUseCompression

isTryUseCompression(): boolean

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

isUseAlpn

isUseAlpn(): boolean

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

isUserAgentEnabled

isUserAgentEnabled(): boolean

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

Returns boolean

isVerifyHost

isVerifyHost(): boolean

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

setActivityLogDataFormat

setActivityLogDataFormat(activityLogDataFormat: any): WebClientOptions

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

setAlpnVersions

setAlpnVersions(alpnVersions: HttpVersion[]): WebClientOptions

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

setConnectTimeout

setConnectTimeout(connectTimeout: number): WebClientOptions

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

setDecoderInitialBufferSize

setDecoderInitialBufferSize(decoderInitialBufferSize: number): WebClientOptions

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

setDefaultHost

setDefaultHost(defaultHost: string): WebClientOptions

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

setDefaultPort

setDefaultPort(defaultPort: number): WebClientOptions

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

setEnabledSecureTransportProtocols

setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): WebClientOptions

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

setFollowRedirects

setFollowRedirects(followRedirects: boolean): WebClientOptions

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

Parameters
- followRedirects: boolean
Returns WebClientOptions

setForceSni

setForceSni(forceSni: boolean): WebClientOptions

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

setHttp2ClearTextUpgrade

setHttp2ClearTextUpgrade(http2ClearTextUpgrade: boolean): WebClientOptions

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

setHttp2ClearTextUpgradeWithPreflightRequest

setHttp2ClearTextUpgradeWithPreflightRequest(http2ClearTextUpgradeWithPreflightRequest: boolean): WebClientOptions

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

setHttp2ConnectionWindowSize

setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): WebClientOptions

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

setHttp2KeepAliveTimeout

setHttp2KeepAliveTimeout(http2KeepAliveTimeout: number): WebClientOptions

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

setHttp2MaxPoolSize

setHttp2MaxPoolSize(http2MaxPoolSize: number): WebClientOptions

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

setHttp2MultiplexingLimit

setHttp2MultiplexingLimit(http2MultiplexingLimit: number): WebClientOptions

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

setIdleTimeout

setIdleTimeout(idleTimeout: number): WebClientOptions

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

setIdleTimeoutUnit

setIdleTimeoutUnit(idleTimeoutUnit: any): WebClientOptions

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

setInitialSettings

setInitialSettings(initialSettings: Http2Settings): WebClientOptions

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

setJdkSslEngineOptions

setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): WebClientOptions

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

setKeepAlive

setKeepAlive(keepAlive: boolean): WebClientOptions

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

setKeepAliveTimeout

setKeepAliveTimeout(keepAliveTimeout: number): WebClientOptions

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

setKeyCertOptions

setKeyCertOptions(keyCertOptions: any): WebClientOptions

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

setKeyStoreOptions

setKeyStoreOptions(keyStoreOptions: JksOptions): WebClientOptions

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

setLocalAddress

setLocalAddress(localAddress: string): WebClientOptions

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

setLogActivity

setLogActivity(logActivity: boolean): WebClientOptions

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

setMaxChunkSize

setMaxChunkSize(maxChunkSize: number): WebClientOptions

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

setMaxHeaderSize

setMaxHeaderSize(maxHeaderSize: number): WebClientOptions

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

setMaxInitialLineLength

setMaxInitialLineLength(maxInitialLineLength: number): WebClientOptions

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

setMaxPoolSize

setMaxPoolSize(maxPoolSize: number): WebClientOptions

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

setMaxRedirects

setMaxRedirects(maxRedirects: number): WebClientOptions

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

setMaxWaitQueueSize

setMaxWaitQueueSize(maxWaitQueueSize: number): WebClientOptions

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

setMaxWebSocketFrameSize

setMaxWebSocketFrameSize(maxWebSocketFrameSize: number): WebClientOptions

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

setMaxWebSocketMessageSize

setMaxWebSocketMessageSize(maxWebSocketMessageSize: number): WebClientOptions

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

setMaxWebSockets

setMaxWebSockets(maxWebSockets: number): WebClientOptions

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

setMetricsName

setMetricsName(metricsName: string): WebClientOptions

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

setName

setName(name: string): WebClientOptions

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

setNonProxyHosts

setNonProxyHosts(nonProxyHosts: string[]): WebClientOptions

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

setOpenSslEngineOptions

setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): WebClientOptions

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

setPemKeyCertOptions

setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): WebClientOptions

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

setPemTrustOptions

setPemTrustOptions(pemTrustOptions: PemTrustOptions): WebClientOptions

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

setPfxKeyCertOptions

setPfxKeyCertOptions(pfxKeyCertOptions: PfxOptions): WebClientOptions

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

setPfxTrustOptions

setPfxTrustOptions(pfxTrustOptions: PfxOptions): WebClientOptions

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

setPipelining

setPipelining(pipelining: boolean): WebClientOptions

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

setPipeliningLimit

setPipeliningLimit(pipeliningLimit: number): WebClientOptions

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

setPoolCleanerPeriod

setPoolCleanerPeriod(poolCleanerPeriod: number): WebClientOptions

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

setPoolEventLoopSize

setPoolEventLoopSize(poolEventLoopSize: number): WebClientOptions

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

setProtocolVersion

setProtocolVersion(protocolVersion: HttpVersion): WebClientOptions

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

setProxyOptions

setProxyOptions(proxyOptions: ProxyOptions): WebClientOptions

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

setReadIdleTimeout

setReadIdleTimeout(readIdleTimeout: number): WebClientOptions

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

setReceiveBufferSize

setReceiveBufferSize(receiveBufferSize: number): WebClientOptions

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

setReuseAddress

setReuseAddress(reuseAddress: boolean): WebClientOptions

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

setReusePort

setReusePort(reusePort: boolean): WebClientOptions

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

setSendBufferSize

setSendBufferSize(sendBufferSize: number): WebClientOptions

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

setSendUnmaskedFrames

setSendUnmaskedFrames(sendUnmaskedFrames: boolean): WebClientOptions

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

setShared

setShared(shared: boolean): WebClientOptions

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

setSoLinger

setSoLinger(soLinger: number): WebClientOptions

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

setSsl

setSsl(ssl: boolean): WebClientOptions

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

setSslEngineOptions

setSslEngineOptions(sslEngineOptions: any): WebClientOptions

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

setSslHandshakeTimeout

setSslHandshakeTimeout(sslHandshakeTimeout: number): WebClientOptions

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

setSslHandshakeTimeoutUnit

setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): WebClientOptions

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

setTcpCork

setTcpCork(tcpCork: boolean): WebClientOptions

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

setTcpFastOpen

setTcpFastOpen(tcpFastOpen: boolean): WebClientOptions

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

setTcpKeepAlive

setTcpKeepAlive(tcpKeepAlive: boolean): WebClientOptions

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

setTcpNoDelay

setTcpNoDelay(tcpNoDelay: boolean): WebClientOptions

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

setTcpQuickAck

setTcpQuickAck(tcpQuickAck: boolean): WebClientOptions

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

setTcpUserTimeout

setTcpUserTimeout(tcpUserTimeout: number): WebClientOptions

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

setTemplateExpandOptions

setTemplateExpandOptions(templateExpandOptions: ExpandOptions): WebClientOptions

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

setTracingPolicy

setTracingPolicy(tracingPolicy: TracingPolicy): WebClientOptions

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

setTrafficClass

setTrafficClass(trafficClass: number): WebClientOptions

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

setTrustAll

setTrustAll(trustAll: boolean): WebClientOptions

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

setTrustOptions

setTrustOptions(trustOptions: any): WebClientOptions

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

setTrustStoreOptions

setTrustStoreOptions(trustStoreOptions: JksOptions): WebClientOptions

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

setTryUseCompression

setTryUseCompression(tryUseCompression: boolean): WebClientOptions

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

setTryUsePerFrameWebSocketCompression

setTryUsePerFrameWebSocketCompression(tryUsePerFrameWebSocketCompression: boolean): WebClientOptions

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

setTryUsePerMessageWebSocketCompression

setTryUsePerMessageWebSocketCompression(tryUsePerMessageWebSocketCompression: boolean): WebClientOptions

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

setUseAlpn

setUseAlpn(useAlpn: boolean): WebClientOptions

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

setUserAgent

setUserAgent(userAgent: string): WebClientOptions

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

Parameters
- userAgent: string
Returns WebClientOptions

setUserAgentEnabled

setUserAgentEnabled(userAgentEnabled: boolean): WebClientOptions

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

Parameters
- userAgentEnabled: boolean
Returns WebClientOptions

setVerifyHost

setVerifyHost(verifyHost: boolean): WebClientOptions

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

setWebSocketClosingTimeout

setWebSocketClosingTimeout(webSocketClosingTimeout: number): WebClientOptions

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

setWebSocketCompressionAllowClientNoContext

setWebSocketCompressionAllowClientNoContext(webSocketCompressionAllowClientNoContext: boolean): WebClientOptions

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

setWebSocketCompressionLevel

setWebSocketCompressionLevel(webSocketCompressionLevel: number): WebClientOptions

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

setWebSocketCompressionRequestServerNoContext

setWebSocketCompressionRequestServerNoContext(webSocketCompressionRequestServerNoContext: boolean): WebClientOptions

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

setWriteIdleTimeout

setWriteIdleTimeout(writeIdleTimeout: number): WebClientOptions

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

toJson

toJson(): {}

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

Generated using TypeDoc