Package com.azure.cosmos

Class GatewayConnectionConfig

java.lang.Object
com.azure.cosmos.GatewayConnectionConfig
public final class GatewayConnectionConfig extends Object
Represents the connection config with ConnectionMode.GATEWAY associated with Cosmos Client in the Azure Cosmos DB database service.

  • Constructor Details

    • GatewayConnectionConfig

      public GatewayConnectionConfig()
      Constructor.

  • Method Details

    • getDefaultConfig

      public static GatewayConnectionConfig getDefaultConfig()
      Gets the default Gateway connection configuration.
      Returns:
      the default gateway connection configuration.

    • getMaxConnectionPoolSize

      public int getMaxConnectionPoolSize()
      Gets the value of the connection pool size the client is using.
      Returns:
      connection pool size.

    • setMaxConnectionPoolSize

      public GatewayConnectionConfig setMaxConnectionPoolSize(int maxConnectionPoolSize)
      Sets the value of the connection pool size, the default is 1000.
      Parameters:
      maxConnectionPoolSize - The value of the connection pool size.
      Returns:
      the GatewayConnectionConfig.

    • getIdleConnectionTimeout

      public Duration getIdleConnectionTimeout()
      Gets the value of the timeout for an idle connection, the default is 60 seconds.
      Returns:
      Idle connection timeout duration.

    • setIdleConnectionTimeout

      public GatewayConnectionConfig setIdleConnectionTimeout(Duration idleConnectionTimeout)
      sets the value of the timeout for an idle connection. After that time, the connection will be automatically closed.
      Parameters:
      idleConnectionTimeout - the duration for an idle connection.
      Returns:
      the GatewayConnectionConfig.

    • getProxy

      public com.azure.core.http.ProxyOptions getProxy()
      Gets the proxy options which contain the InetSocketAddress of proxy server.
      Returns:
      the proxy options.

    • setProxy

      public GatewayConnectionConfig setProxy(com.azure.core.http.ProxyOptions proxy)
      Sets the proxy options.
      Parameters:
      proxy - The proxy options.
      Returns:
      the GatewayConnectionConfig.

    • toString

      public String toString()
      Overrides:
      toString in class Object