PgConnectOptions (Reactive Postgres Client 0.11.2 API)

java.lang.Object
- io.vertx.core.net.NetworkOptions
- - io.vertx.core.net.TCPSSLOptions
  - - io.vertx.core.net.ClientOptionsBase
    - - io.vertx.core.net.NetClientOptions
      - io.reactiverse.pgclient.PgConnectOptions

Direct Known Subclasses:: PgPoolOptions

public class PgConnectOptions
extends io.vertx.core.net.NetClientOptions

Author:: Julien Viet, Billy Yuan

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_CACHE_PREPARED_STATEMENTS`
`static String`	`DEFAULT_DATABASE`
`static String`	`DEFAULT_HOST`
`static String`	`DEFAULT_PASSWORD`
`static int`	`DEFAULT_PIPELINING_LIMIT`
`static int`	`DEFAULT_PORT`
`static SslMode`	`DEFAULT_SSLMODE`
`static String`	`DEFAULT_USER`

Fields inherited from class io.vertx.core.net.NetClientOptions
DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

Fields inherited from class io.vertx.core.net.ClientOptionsBase
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL

Fields inherited from class io.vertx.core.net.TCPSSLOptions
DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPN, DEFAULT_USE_POOLED_BUFFERS

Fields inherited from class io.vertx.core.net.NetworkOptions
DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors
Constructor and Description

PgConnectOptions()

PgConnectOptions(io.vertx.core.json.JsonObject json)

PgConnectOptions(PgConnectOptions other)

Constructors
Constructor and Description
`PgConnectOptions()`
`PgConnectOptions(io.vertx.core.json.JsonObject json)`
`PgConnectOptions(PgConnectOptions other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PgConnectOptions`	`addCrlPath(String crlPath)`
`PgConnectOptions`	`addCrlValue(io.vertx.core.buffer.Buffer crlValue)`
`PgConnectOptions`	`addEnabledCipherSuite(String suite)`
`PgConnectOptions`	`addEnabledSecureTransportProtocol(String protocol)`
`boolean`	`equals(Object o)`
`static PgConnectOptions`	`fromEnv()` Provide a `PgConnectOptions` configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
`static PgConnectOptions`	`fromUri(String connectionUri)` Provide a `PgConnectOptions` configured from a connection URI.
`boolean`	`getCachePreparedStatements()`
`String`	`getDatabase()`
`String`	`getHost()`
`String`	`getPassword()`
`int`	`getPipeliningLimit()`
`int`	`getPort()`
`SslMode`	`getSslMode()`
`String`	`getUser()`
`int`	`hashCode()`
`boolean`	`isUsingDomainSocket()`
`PgConnectOptions`	`setCachePreparedStatements(boolean cachePreparedStatements)`
`PgConnectOptions`	`setConnectTimeout(int connectTimeout)`
`PgConnectOptions`	`setDatabase(String database)`
`PgConnectOptions`	`setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)`
`PgConnectOptions`	`setHost(String host)`
`PgConnectOptions`	`setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)`
`PgConnectOptions`	`setIdleTimeout(int idleTimeout)`
`PgConnectOptions`	`setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)`
`PgConnectOptions`	`setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)`
`PgConnectOptions`	`setKeyStoreOptions(io.vertx.core.net.JksOptions options)`
`PgConnectOptions`	`setLocalAddress(String localAddress)`
`PgConnectOptions`	`setLogActivity(boolean logEnabled)`
`PgConnectOptions`	`setMetricsName(String metricsName)`
`PgConnectOptions`	`setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)`
`PgConnectOptions`	`setPassword(String password)`
`PgConnectOptions`	`setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)`
`PgConnectOptions`	`setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)`
`PgConnectOptions`	`setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)`
`PgConnectOptions`	`setPfxTrustOptions(io.vertx.core.net.PfxOptions options)`
`PgConnectOptions`	`setPipeliningLimit(int pipeliningLimit)`
`PgConnectOptions`	`setPort(int port)`
`PgConnectOptions`	`setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)`
`PgConnectOptions`	`setReceiveBufferSize(int receiveBufferSize)`
`PgConnectOptions`	`setReconnectAttempts(int attempts)`
`PgConnectOptions`	`setReconnectInterval(long interval)`
`PgConnectOptions`	`setReuseAddress(boolean reuseAddress)`
`PgConnectOptions`	`setReusePort(boolean reusePort)`
`PgConnectOptions`	`setSendBufferSize(int sendBufferSize)`
`PgConnectOptions`	`setSoLinger(int soLinger)`
`PgConnectOptions`	`setSsl(boolean ssl)`
`PgConnectOptions`	`setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)`
`PgConnectOptions`	`setSslMode(SslMode sslmode)` Set `SslMode` for the client, this option can be used to provide different levels of secure protection.
`PgConnectOptions`	`setTcpCork(boolean tcpCork)`
`PgConnectOptions`	`setTcpFastOpen(boolean tcpFastOpen)`
`PgConnectOptions`	`setTcpKeepAlive(boolean tcpKeepAlive)`
`PgConnectOptions`	`setTcpNoDelay(boolean tcpNoDelay)`
`PgConnectOptions`	`setTcpQuickAck(boolean tcpQuickAck)`
`PgConnectOptions`	`setTrafficClass(int trafficClass)`
`PgConnectOptions`	`setTrustAll(boolean trustAll)`
`PgConnectOptions`	`setTrustOptions(io.vertx.core.net.TrustOptions options)`
`PgConnectOptions`	`setTrustStoreOptions(io.vertx.core.net.JksOptions options)`
`PgConnectOptions`	`setUseAlpn(boolean useAlpn)`
`PgConnectOptions`	`setUsePooledBuffers(boolean usePooledBuffers)`
`PgConnectOptions`	`setUser(String user)`
`io.vertx.core.json.JsonObject`	`toJson()`

Methods inherited from class io.vertx.core.net.NetClientOptions
getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, removeEnabledSecureTransportProtocol, setIdleTimeoutUnit

Methods inherited from class io.vertx.core.net.ClientOptionsBase
getConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAll

Methods inherited from class io.vertx.core.net.TCPSSLOptions
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, isUsePooledBuffers

Methods inherited from class io.vertx.core.net.NetworkOptions
getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_HOST
```
public static final String DEFAULT_HOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static int DEFAULT_PORT
```
  - DEFAULT_DATABASE
```
public static final String DEFAULT_DATABASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_USER
```
public static final String DEFAULT_USER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PASSWORD
```
public static final String DEFAULT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_PREPARED_STATEMENTS
```
public static final boolean DEFAULT_CACHE_PREPARED_STATEMENTS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PIPELINING_LIMIT
```
public static final int DEFAULT_PIPELINING_LIMIT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SSLMODE
```
public static final SslMode DEFAULT_SSLMODE
```
- Constructor Detail
  - PgConnectOptions
```
public PgConnectOptions()
```
  - PgConnectOptions
```
public PgConnectOptions(io.vertx.core.json.JsonObject json)
```
  - PgConnectOptions
```
public PgConnectOptions(PgConnectOptions other)
```
- Method Detail
  - fromUri
```
public static PgConnectOptions fromUri(String connectionUri)
                                throws IllegalArgumentException
```
    Provide a PgConnectOptions configured from a connection URI.
    
    Parameters:
    
    connectionUri - the connection URI to configure from
    
    Returns:
    
    a PgConnectOptions parsed from the connection URI
    
    Throws:
    
    IllegalArgumentException - when the connectionUri is in an invalid format
  - fromEnv
```
public static PgConnectOptions fromEnv()
```
    Provide a PgConnectOptions configured with environment variables, if the environment variable is not set, then a default value will take precedence over this.
  - getHost
```
public String getHost()
```
  - setHost
```
public PgConnectOptions setHost(String host)
```
  - getPort
```
public int getPort()
```
  - setPort
```
public PgConnectOptions setPort(int port)
```
  - getDatabase
```
public String getDatabase()
```
  - setDatabase
```
public PgConnectOptions setDatabase(String database)
```
  - getUser
```
public String getUser()
```
  - setUser
```
public PgConnectOptions setUser(String user)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public PgConnectOptions setPassword(String password)
```
  - getPipeliningLimit
```
public int getPipeliningLimit()
```
  - setPipeliningLimit
```
public PgConnectOptions setPipeliningLimit(int pipeliningLimit)
```
  - getCachePreparedStatements
```
public boolean getCachePreparedStatements()
```
  - setCachePreparedStatements
```
public PgConnectOptions setCachePreparedStatements(boolean cachePreparedStatements)
```
  - getSslMode
```
public SslMode getSslMode()
```
    Returns:
    
    the value of current sslmode
  - setSslMode
```
public PgConnectOptions setSslMode(SslMode sslmode)
```
    Set SslMode for the client, this option can be used to provide different levels of secure protection.
    
    Parameters:
    
    sslmode - the value of sslmode
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setSendBufferSize
```
public PgConnectOptions setSendBufferSize(int sendBufferSize)
```
    Overrides:
    
    setSendBufferSize in class io.vertx.core.net.NetClientOptions
  - setReceiveBufferSize
```
public PgConnectOptions setReceiveBufferSize(int receiveBufferSize)
```
    Overrides:
    
    setReceiveBufferSize in class io.vertx.core.net.NetClientOptions
  - setReuseAddress
```
public PgConnectOptions setReuseAddress(boolean reuseAddress)
```
    Overrides:
    
    setReuseAddress in class io.vertx.core.net.NetClientOptions
  - setTrafficClass
```
public PgConnectOptions setTrafficClass(int trafficClass)
```
    Overrides:
    
    setTrafficClass in class io.vertx.core.net.NetClientOptions
  - setTcpNoDelay
```
public PgConnectOptions setTcpNoDelay(boolean tcpNoDelay)
```
    Overrides:
    
    setTcpNoDelay in class io.vertx.core.net.NetClientOptions
  - setTcpKeepAlive
```
public PgConnectOptions setTcpKeepAlive(boolean tcpKeepAlive)
```
    Overrides:
    
    setTcpKeepAlive in class io.vertx.core.net.NetClientOptions
  - setSoLinger
```
public PgConnectOptions setSoLinger(int soLinger)
```
    Overrides:
    
    setSoLinger in class io.vertx.core.net.NetClientOptions
  - setUsePooledBuffers
```
public PgConnectOptions setUsePooledBuffers(boolean usePooledBuffers)
```
    Overrides:
    
    setUsePooledBuffers in class io.vertx.core.net.NetClientOptions
  - setIdleTimeout
```
public PgConnectOptions setIdleTimeout(int idleTimeout)
```
    Overrides:
    
    setIdleTimeout in class io.vertx.core.net.NetClientOptions
  - setSsl
```
public PgConnectOptions setSsl(boolean ssl)
```
    Overrides:
    
    setSsl in class io.vertx.core.net.NetClientOptions
  - setKeyCertOptions
```
public PgConnectOptions setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)
```
    Overrides:
    
    setKeyCertOptions in class io.vertx.core.net.NetClientOptions
  - setKeyStoreOptions
```
public PgConnectOptions setKeyStoreOptions(io.vertx.core.net.JksOptions options)
```
    Overrides:
    
    setKeyStoreOptions in class io.vertx.core.net.NetClientOptions
  - setPfxKeyCertOptions
```
public PgConnectOptions setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)
```
    Overrides:
    
    setPfxKeyCertOptions in class io.vertx.core.net.NetClientOptions
  - setPemKeyCertOptions
```
public PgConnectOptions setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)
```
    Overrides:
    
    setPemKeyCertOptions in class io.vertx.core.net.NetClientOptions
  - setTrustOptions
```
public PgConnectOptions setTrustOptions(io.vertx.core.net.TrustOptions options)
```
    Overrides:
    
    setTrustOptions in class io.vertx.core.net.NetClientOptions
  - setTrustStoreOptions
```
public PgConnectOptions setTrustStoreOptions(io.vertx.core.net.JksOptions options)
```
    Overrides:
    
    setTrustStoreOptions in class io.vertx.core.net.NetClientOptions
  - setPemTrustOptions
```
public PgConnectOptions setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)
```
    Overrides:
    
    setPemTrustOptions in class io.vertx.core.net.NetClientOptions
  - setPfxTrustOptions
```
public PgConnectOptions setPfxTrustOptions(io.vertx.core.net.PfxOptions options)
```
    Overrides:
    
    setPfxTrustOptions in class io.vertx.core.net.NetClientOptions
  - addEnabledCipherSuite
```
public PgConnectOptions addEnabledCipherSuite(String suite)
```
    Overrides:
    
    addEnabledCipherSuite in class io.vertx.core.net.NetClientOptions
  - addEnabledSecureTransportProtocol
```
public PgConnectOptions addEnabledSecureTransportProtocol(String protocol)
```
    Overrides:
    
    addEnabledSecureTransportProtocol in class io.vertx.core.net.NetClientOptions
  - addCrlPath
```
public PgConnectOptions addCrlPath(String crlPath)
                            throws NullPointerException
```
    Overrides:
    
    addCrlPath in class io.vertx.core.net.NetClientOptions
    
    Throws:
    
    NullPointerException
  - addCrlValue
```
public PgConnectOptions addCrlValue(io.vertx.core.buffer.Buffer crlValue)
                             throws NullPointerException
```
    Overrides:
    
    addCrlValue in class io.vertx.core.net.NetClientOptions
    
    Throws:
    
    NullPointerException
  - setTrustAll
```
public PgConnectOptions setTrustAll(boolean trustAll)
```
    Overrides:
    
    setTrustAll in class io.vertx.core.net.NetClientOptions
  - setConnectTimeout
```
public PgConnectOptions setConnectTimeout(int connectTimeout)
```
    Overrides:
    
    setConnectTimeout in class io.vertx.core.net.NetClientOptions
  - setMetricsName
```
public PgConnectOptions setMetricsName(String metricsName)
```
    Overrides:
    
    setMetricsName in class io.vertx.core.net.NetClientOptions
  - setReconnectAttempts
```
public PgConnectOptions setReconnectAttempts(int attempts)
```
    Overrides:
    
    setReconnectAttempts in class io.vertx.core.net.NetClientOptions
  - setHostnameVerificationAlgorithm
```
public PgConnectOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
```
    Overrides:
    
    setHostnameVerificationAlgorithm in class io.vertx.core.net.NetClientOptions
  - setLogActivity
```
public PgConnectOptions setLogActivity(boolean logEnabled)
```
    Overrides:
    
    setLogActivity in class io.vertx.core.net.NetClientOptions
  - setReconnectInterval
```
public PgConnectOptions setReconnectInterval(long interval)
```
    Overrides:
    
    setReconnectInterval in class io.vertx.core.net.NetClientOptions
  - setProxyOptions
```
public PgConnectOptions setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)
```
    Overrides:
    
    setProxyOptions in class io.vertx.core.net.NetClientOptions
  - setLocalAddress
```
public PgConnectOptions setLocalAddress(String localAddress)
```
    Overrides:
    
    setLocalAddress in class io.vertx.core.net.NetClientOptions
  - setUseAlpn
```
public PgConnectOptions setUseAlpn(boolean useAlpn)
```
    Overrides:
    
    setUseAlpn in class io.vertx.core.net.NetClientOptions
  - setSslEngineOptions
```
public PgConnectOptions setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)
```
    Overrides:
    
    setSslEngineOptions in class io.vertx.core.net.NetClientOptions
  - setJdkSslEngineOptions
```
public PgConnectOptions setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)
```
    Overrides:
    
    setJdkSslEngineOptions in class io.vertx.core.net.NetClientOptions
  - setOpenSslEngineOptions
```
public PgConnectOptions setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)
```
    Overrides:
    
    setOpenSslEngineOptions in class io.vertx.core.net.NetClientOptions
  - setReusePort
```
public PgConnectOptions setReusePort(boolean reusePort)
```
    Overrides:
    
    setReusePort in class io.vertx.core.net.NetClientOptions
  - setTcpFastOpen
```
public PgConnectOptions setTcpFastOpen(boolean tcpFastOpen)
```
    Overrides:
    
    setTcpFastOpen in class io.vertx.core.net.NetClientOptions
  - setTcpCork
```
public PgConnectOptions setTcpCork(boolean tcpCork)
```
    Overrides:
    
    setTcpCork in class io.vertx.core.net.NetClientOptions
  - setTcpQuickAck
```
public PgConnectOptions setTcpQuickAck(boolean tcpQuickAck)
```
    Overrides:
    
    setTcpQuickAck in class io.vertx.core.net.NetClientOptions
  - setEnabledSecureTransportProtocols
```
public PgConnectOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
```
    Overrides:
    
    setEnabledSecureTransportProtocols in class io.vertx.core.net.NetClientOptions
  - toJson
```
public io.vertx.core.json.JsonObject toJson()
```
    Overrides:
    
    toJson in class io.vertx.core.net.ClientOptionsBase
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class io.vertx.core.net.NetClientOptions
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class io.vertx.core.net.NetClientOptions
  - isUsingDomainSocket
```
public boolean isUsingDomainSocket()
```

Class PgConnectOptions

Field Summary

Fields inherited from class io.vertx.core.net.NetClientOptions

Fields inherited from class io.vertx.core.net.ClientOptionsBase

Fields inherited from class io.vertx.core.net.TCPSSLOptions

Fields inherited from class io.vertx.core.net.NetworkOptions

Constructor Summary

Method Summary

Methods inherited from class io.vertx.core.net.NetClientOptions

Methods inherited from class io.vertx.core.net.ClientOptionsBase

Methods inherited from class io.vertx.core.net.TCPSSLOptions

Methods inherited from class io.vertx.core.net.NetworkOptions

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST

DEFAULT_PORT

DEFAULT_DATABASE

DEFAULT_USER

DEFAULT_PASSWORD

DEFAULT_CACHE_PREPARED_STATEMENTS

DEFAULT_PIPELINING_LIMIT

DEFAULT_SSLMODE

Constructor Detail

PgConnectOptions

PgConnectOptions

PgConnectOptions

Method Detail

fromUri

fromEnv

getHost

setHost

getPort

setPort

getDatabase

setDatabase

getUser

setUser

getPassword

setPassword

getPipeliningLimit

setPipeliningLimit

getCachePreparedStatements

setCachePreparedStatements

getSslMode

setSslMode

setSendBufferSize

setReceiveBufferSize

setReuseAddress

setTrafficClass

setTcpNoDelay

setTcpKeepAlive

setSoLinger

setUsePooledBuffers

setIdleTimeout

setSsl

setKeyCertOptions

setKeyStoreOptions

setPfxKeyCertOptions

setPemKeyCertOptions

setTrustOptions

setTrustStoreOptions

setPemTrustOptions

setPfxTrustOptions

addEnabledCipherSuite

addEnabledSecureTransportProtocol

addCrlPath

addCrlValue

setTrustAll

setConnectTimeout

setMetricsName

setReconnectAttempts

setHostnameVerificationAlgorithm

setLogActivity

setReconnectInterval

setProxyOptions

setLocalAddress

setUseAlpn

setSslEngineOptions

setJdkSslEngineOptions

setOpenSslEngineOptions