Skip to content

docs: clarify that ClientOptions.maxConnections and maxConnectionsPerHost only limit asynchronous requests #1378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −4
Open

docs: clarify that ClientOptions.maxConnections and maxConnectionsPerHost only limit asynchronous requests #1378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/main/java/com/google/genai/types/ClientOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,17 @@
@AutoValue
@JsonDeserialize(builder = ClientOptions.Builder.class)
public abstract class ClientOptions extends JsonSerializable {
/** The maximum number of connections allowed in the pool. */
/**
* The maximum number of asynchronous requests that run at the same time. Defaults to 64.
* Synchronous requests are not limited. Ignored when `customHttpClient` is set.
*/
@JsonProperty("maxConnections")
public abstract Optional<Integer> maxConnections();

/** The maximum number of connections allowed per host. */
/**
* The maximum number of asynchronous requests to the same host that run at the same time.
* Defaults to 5. Synchronous requests are not limited. Ignored when `customHttpClient` is set.
*/
@JsonProperty("maxConnectionsPerHost")
public abstract Optional<Integer> maxConnectionsPerHost();

Expand Down Expand Up @@ -69,7 +75,8 @@ private static Builder create() {
/**
* Setter for maxConnections.
*
* <p>maxConnections: The maximum number of connections allowed in the pool.
* <p>maxConnections: The maximum number of asynchronous requests that run at the same time.
* Defaults to 64. Synchronous requests are not limited. Ignored when `customHttpClient` is set.
*/
@JsonProperty("maxConnections")
public abstract Builder maxConnections(Integer maxConnections);
Expand All @@ -87,7 +94,9 @@ public Builder clearMaxConnections() {
/**
* Setter for maxConnectionsPerHost.
*
* <p>maxConnectionsPerHost: The maximum number of connections allowed per host.
* <p>maxConnectionsPerHost: The maximum number of asynchronous requests to the same host that
* run at the same time. Defaults to 5. Synchronous requests are not limited. Ignored when
* `customHttpClient` is set.
*/
@JsonProperty("maxConnectionsPerHost")
public abstract Builder maxConnectionsPerHost(Integer maxConnectionsPerHost);
Expand Down
Loading