130 строки
8.9 KiB
YAML
130 строки
8.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.GatewayConnectionConfig"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig"
|
|
name: "GatewayConnectionConfig"
|
|
nameWithType: "GatewayConnectionConfig"
|
|
summary: "Represents the connection config with <xref uid=\"com.azure.cosmos.ConnectionMode.GATEWAY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionMode#GATEWAY\"></xref> associated with Cosmos Client in the Azure Cosmos DB database service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **GatewayConnectionConfig**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.GatewayConnectionConfig()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.GatewayConnectionConfig()"
|
|
name: "GatewayConnectionConfig()"
|
|
nameWithType: "GatewayConnectionConfig.GatewayConnectionConfig()"
|
|
summary: "Constructor."
|
|
syntax: "public GatewayConnectionConfig()"
|
|
desc: "Constructor."
|
|
methods:
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.getDefaultConfig()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.getDefaultConfig()"
|
|
name: "getDefaultConfig()"
|
|
nameWithType: "GatewayConnectionConfig.getDefaultConfig()"
|
|
summary: "Gets the default Gateway connection configuration."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static GatewayConnectionConfig getDefaultConfig()"
|
|
desc: "Gets the default Gateway connection configuration."
|
|
returns:
|
|
description: "the default gateway connection configuration."
|
|
type: "<xref href=\"com.azure.cosmos.GatewayConnectionConfig?alt=com.azure.cosmos.GatewayConnectionConfig&text=GatewayConnectionConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.getIdleConnectionTimeout()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.getIdleConnectionTimeout()"
|
|
name: "getIdleConnectionTimeout()"
|
|
nameWithType: "GatewayConnectionConfig.getIdleConnectionTimeout()"
|
|
summary: "Gets the value of the timeout for an idle connection, the default is 60 seconds."
|
|
syntax: "public Duration getIdleConnectionTimeout()"
|
|
desc: "Gets the value of the timeout for an idle connection, the default is 60 seconds."
|
|
returns:
|
|
description: "Idle connection timeout duration."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.getMaxConnectionPoolSize()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.getMaxConnectionPoolSize()"
|
|
name: "getMaxConnectionPoolSize()"
|
|
nameWithType: "GatewayConnectionConfig.getMaxConnectionPoolSize()"
|
|
summary: "Gets the value of the connection pool size the client is using."
|
|
syntax: "public int getMaxConnectionPoolSize()"
|
|
desc: "Gets the value of the connection pool size the client is using."
|
|
returns:
|
|
description: "connection pool size."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.getProxy()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.getProxy()"
|
|
name: "getProxy()"
|
|
nameWithType: "GatewayConnectionConfig.getProxy()"
|
|
summary: "Gets the proxy options which contain the Inet<wbr>Socket<wbr>Address of proxy server."
|
|
syntax: "public ProxyOptions getProxy()"
|
|
desc: "Gets the proxy options which contain the InetSocketAddress of proxy server."
|
|
returns:
|
|
description: "the proxy options."
|
|
type: "<xref href=\"com.azure.core.http.ProxyOptions?alt=com.azure.core.http.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.setIdleConnectionTimeout(java.time.Duration)"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.setIdleConnectionTimeout(Duration idleConnectionTimeout)"
|
|
name: "setIdleConnectionTimeout(Duration idleConnectionTimeout)"
|
|
nameWithType: "GatewayConnectionConfig.setIdleConnectionTimeout(Duration idleConnectionTimeout)"
|
|
summary: "sets the value of the timeout for an idle connection."
|
|
parameters:
|
|
- description: "the duration for an idle connection."
|
|
name: "idleConnectionTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public GatewayConnectionConfig setIdleConnectionTimeout(Duration idleConnectionTimeout)"
|
|
desc: "sets the value of the timeout for an idle connection. After that time, the connection will be automatically closed."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.cosmos.GatewayConnectionConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GatewayConnectionConfig\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.GatewayConnectionConfig?alt=com.azure.cosmos.GatewayConnectionConfig&text=GatewayConnectionConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.setMaxConnectionPoolSize(int)"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.setMaxConnectionPoolSize(int maxConnectionPoolSize)"
|
|
name: "setMaxConnectionPoolSize(int maxConnectionPoolSize)"
|
|
nameWithType: "GatewayConnectionConfig.setMaxConnectionPoolSize(int maxConnectionPoolSize)"
|
|
summary: "Sets the value of the connection pool size, the default is 1000."
|
|
parameters:
|
|
- description: "The value of the connection pool size."
|
|
name: "maxConnectionPoolSize"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public GatewayConnectionConfig setMaxConnectionPoolSize(int maxConnectionPoolSize)"
|
|
desc: "Sets the value of the connection pool size, the default is 1000."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.cosmos.GatewayConnectionConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GatewayConnectionConfig\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.GatewayConnectionConfig?alt=com.azure.cosmos.GatewayConnectionConfig&text=GatewayConnectionConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.setProxy(com.azure.core.http.ProxyOptions)"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.setProxy(ProxyOptions proxy)"
|
|
name: "setProxy(ProxyOptions proxy)"
|
|
nameWithType: "GatewayConnectionConfig.setProxy(ProxyOptions proxy)"
|
|
summary: "Sets the proxy options."
|
|
parameters:
|
|
- description: "The proxy options."
|
|
name: "proxy"
|
|
type: "<xref href=\"com.azure.core.http.ProxyOptions?alt=com.azure.core.http.ProxyOptions&text=ProxyOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public GatewayConnectionConfig setProxy(ProxyOptions proxy)"
|
|
desc: "Sets the proxy options."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.cosmos.GatewayConnectionConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"GatewayConnectionConfig\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.GatewayConnectionConfig?alt=com.azure.cosmos.GatewayConnectionConfig&text=GatewayConnectionConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.GatewayConnectionConfig.toString()"
|
|
fullName: "com.azure.cosmos.GatewayConnectionConfig.toString()"
|
|
name: "toString()"
|
|
nameWithType: "GatewayConnectionConfig.toString()"
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "Represents the connection config with <xref uid=\"com.azure.cosmos.ConnectionMode.GATEWAY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConnectionMode#GATEWAY\"></xref> associated with Cosmos Client in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|