feat(client): add a withOptions method

Author: stainless-app[bot]

README.md

@@ -122,6 +122,21 @@ See this table for the available options:
 > Don't create more than one client in the same application. Each client has a connection pool and
 > thread pools, which are more efficient to share between requests.
 
+### Modifying configuration
+
+To temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:
+
+```java
+import com.openlayer.api.client.OpenlayerClient;
+
+OpenlayerClient clientWithOptions = client.withOptions(optionsBuilder -> {
+    optionsBuilder.baseUrl("https://example.com");
+    optionsBuilder.maxRetries(42);
+});
+```
+
+The `withOptions()` method does not affect the original client or service.
+
 ## Requests and responses
 
 To send a request to the Openlayer API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.

openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClient.kt

@@ -2,10 +2,12 @@
 
 package com.openlayer.api.client
 
+import com.openlayer.api.core.ClientOptions
 import com.openlayer.api.services.blocking.CommitService
 import com.openlayer.api.services.blocking.InferencePipelineService
 import com.openlayer.api.services.blocking.ProjectService
 import com.openlayer.api.services.blocking.StorageService
+import java.util.function.Consumer
 
 /**
  * A client for interacting with the Openlayer REST API synchronously. You can also switch to
@@ -36,6 +38,13 @@ interface OpenlayerClient {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: Consumer<ClientOptions.Builder>): OpenlayerClient
+
     fun projects(): ProjectService
 
     fun commits(): CommitService
@@ -60,6 +69,13 @@ interface OpenlayerClient {
     /** A view of [OpenlayerClient] that provides access to raw HTTP responses for each method. */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(modifier: Consumer<ClientOptions.Builder>): OpenlayerClient.WithRawResponse
+
         fun projects(): ProjectService.WithRawResponse
 
         fun commits(): CommitService.WithRawResponse

openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsync.kt

@@ -2,10 +2,12 @@
 
 package com.openlayer.api.client
 
+import com.openlayer.api.core.ClientOptions
 import com.openlayer.api.services.async.CommitServiceAsync
 import com.openlayer.api.services.async.InferencePipelineServiceAsync
 import com.openlayer.api.services.async.ProjectServiceAsync
 import com.openlayer.api.services.async.StorageServiceAsync
+import java.util.function.Consumer
 
 /**
  * A client for interacting with the Openlayer REST API asynchronously. You can also switch to
@@ -36,6 +38,13 @@ interface OpenlayerClientAsync {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: Consumer<ClientOptions.Builder>): OpenlayerClientAsync
+
     fun projects(): ProjectServiceAsync
 
     fun commits(): CommitServiceAsync
@@ -62,6 +71,15 @@ interface OpenlayerClientAsync {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): OpenlayerClientAsync.WithRawResponse
+
         fun projects(): ProjectServiceAsync.WithRawResponse
 
         fun commits(): CommitServiceAsync.WithRawResponse

openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientAsyncImpl.kt

@@ -12,6 +12,7 @@ import com.openlayer.api.services.async.ProjectServiceAsync
 import com.openlayer.api.services.async.ProjectServiceAsyncImpl
 import com.openlayer.api.services.async.StorageServiceAsync
 import com.openlayer.api.services.async.StorageServiceAsyncImpl
+import java.util.function.Consumer
 
 class OpenlayerClientAsyncImpl(private val clientOptions: ClientOptions) : OpenlayerClientAsync {
 
@@ -50,6 +51,9 @@ class OpenlayerClientAsyncImpl(private val clientOptions: ClientOptions) : Openl
 
     override fun withRawResponse(): OpenlayerClientAsync.WithRawResponse = withRawResponse
 
+    override fun withOptions(modifier: Consumer<ClientOptions.Builder>): OpenlayerClientAsync =
+        OpenlayerClientAsyncImpl(clientOptions.toBuilder().apply(modifier::accept).build())
+
     override fun projects(): ProjectServiceAsync = projects
 
     override fun commits(): CommitServiceAsync = commits
@@ -79,6 +83,13 @@ class OpenlayerClientAsyncImpl(private val clientOptions: ClientOptions) : Openl
             StorageServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
 
+        override fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): OpenlayerClientAsync.WithRawResponse =
+            OpenlayerClientAsyncImpl.WithRawResponseImpl(
+                clientOptions.toBuilder().apply(modifier::accept).build()
+            )
+
         override fun projects(): ProjectServiceAsync.WithRawResponse = projects
 
         override fun commits(): CommitServiceAsync.WithRawResponse = commits

openlayer-java-core/src/main/kotlin/com/openlayer/api/client/OpenlayerClientImpl.kt

@@ -12,6 +12,7 @@ import com.openlayer.api.services.blocking.ProjectService
 import com.openlayer.api.services.blocking.ProjectServiceImpl
 import com.openlayer.api.services.blocking.StorageService
 import com.openlayer.api.services.blocking.StorageServiceImpl
+import java.util.function.Consumer
 
 class OpenlayerClientImpl(private val clientOptions: ClientOptions) : OpenlayerClient {
 
@@ -44,6 +45,9 @@ class OpenlayerClientImpl(private val clientOptions: ClientOptions) : OpenlayerC
 
     override fun withRawResponse(): OpenlayerClient.WithRawResponse = withRawResponse
 
+    override fun withOptions(modifier: Consumer<ClientOptions.Builder>): OpenlayerClient =
+        OpenlayerClientImpl(clientOptions.toBuilder().apply(modifier::accept).build())
+
     override fun projects(): ProjectService = projects
 
     override fun commits(): CommitService = commits
@@ -73,6 +77,13 @@ class OpenlayerClientImpl(private val clientOptions: ClientOptions) : OpenlayerC
             StorageServiceImpl.WithRawResponseImpl(clientOptions)
         }
 
+        override fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): OpenlayerClient.WithRawResponse =
+            OpenlayerClientImpl.WithRawResponseImpl(
+                clientOptions.toBuilder().apply(modifier::accept).build()
+            )
+
         override fun projects(): ProjectService.WithRawResponse = projects
 
         override fun commits(): CommitService.WithRawResponse = commits

openlayer-java-core/src/main/kotlin/com/openlayer/api/services/async/CommitServiceAsync.kt

@@ -2,12 +2,14 @@
 
 package com.openlayer.api.services.async
 
+import com.openlayer.api.core.ClientOptions
 import com.openlayer.api.core.RequestOptions
 import com.openlayer.api.core.http.HttpResponseFor
 import com.openlayer.api.models.commits.CommitRetrieveParams
 import com.openlayer.api.models.commits.CommitRetrieveResponse
 import com.openlayer.api.services.async.commits.TestResultServiceAsync
 import java.util.concurrent.CompletableFuture
+import java.util.function.Consumer
 
 interface CommitServiceAsync {
 
@@ -16,6 +18,13 @@ interface CommitServiceAsync {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: Consumer<ClientOptions.Builder>): CommitServiceAsync
+
     fun testResults(): TestResultServiceAsync
 
     /** Retrieve a project version (commit) by its id. */
@@ -59,6 +68,15 @@ interface CommitServiceAsync {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): CommitServiceAsync.WithRawResponse
+
         fun testResults(): TestResultServiceAsync.WithRawResponse
 
         /**

openlayer-java-core/src/main/kotlin/com/openlayer/api/services/async/CommitServiceAsyncImpl.kt

@@ -20,6 +20,7 @@ import com.openlayer.api.models.commits.CommitRetrieveResponse
 import com.openlayer.api.services.async.commits.TestResultServiceAsync
 import com.openlayer.api.services.async.commits.TestResultServiceAsyncImpl
 import java.util.concurrent.CompletableFuture
+import java.util.function.Consumer
 import kotlin.jvm.optionals.getOrNull
 
 class CommitServiceAsyncImpl internal constructor(private val clientOptions: ClientOptions) :
@@ -35,6 +36,9 @@ class CommitServiceAsyncImpl internal constructor(private val clientOptions: Cli
 
     override fun withRawResponse(): CommitServiceAsync.WithRawResponse = withRawResponse
 
+    override fun withOptions(modifier: Consumer<ClientOptions.Builder>): CommitServiceAsync =
+        CommitServiceAsyncImpl(clientOptions.toBuilder().apply(modifier::accept).build())
+
     override fun testResults(): TestResultServiceAsync = testResults
 
     override fun retrieve(
@@ -53,6 +57,13 @@ class CommitServiceAsyncImpl internal constructor(private val clientOptions: Cli
             TestResultServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
 
+        override fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): CommitServiceAsync.WithRawResponse =
+            CommitServiceAsyncImpl.WithRawResponseImpl(
+                clientOptions.toBuilder().apply(modifier::accept).build()
+            )
+
         override fun testResults(): TestResultServiceAsync.WithRawResponse = testResults
 
         private val retrieveHandler: Handler<CommitRetrieveResponse> =

openlayer-java-core/src/main/kotlin/com/openlayer/api/services/async/InferencePipelineServiceAsync.kt

@@ -2,6 +2,7 @@
 
 package com.openlayer.api.services.async
 
+import com.openlayer.api.core.ClientOptions
 import com.openlayer.api.core.RequestOptions
 import com.openlayer.api.core.http.HttpResponse
 import com.openlayer.api.core.http.HttpResponseFor
@@ -14,6 +15,7 @@ import com.openlayer.api.services.async.inferencepipelines.DataServiceAsync
 import com.openlayer.api.services.async.inferencepipelines.RowServiceAsync
 import com.openlayer.api.services.async.inferencepipelines.TestResultServiceAsync
 import java.util.concurrent.CompletableFuture
+import java.util.function.Consumer
 
 interface InferencePipelineServiceAsync {
 
@@ -22,6 +24,13 @@ interface InferencePipelineServiceAsync {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: Consumer<ClientOptions.Builder>): InferencePipelineServiceAsync
+
     fun data(): DataServiceAsync
 
     fun rows(): RowServiceAsync
@@ -149,6 +158,15 @@ interface InferencePipelineServiceAsync {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): InferencePipelineServiceAsync.WithRawResponse
+
         fun data(): DataServiceAsync.WithRawResponse
 
         fun rows(): RowServiceAsync.WithRawResponse

openlayer-java-core/src/main/kotlin/com/openlayer/api/services/async/InferencePipelineServiceAsyncImpl.kt

@@ -30,6 +30,7 @@ import com.openlayer.api.services.async.inferencepipelines.RowServiceAsyncImpl
 import com.openlayer.api.services.async.inferencepipelines.TestResultServiceAsync
 import com.openlayer.api.services.async.inferencepipelines.TestResultServiceAsyncImpl
 import java.util.concurrent.CompletableFuture
+import java.util.function.Consumer
 import kotlin.jvm.optionals.getOrNull
 
 class InferencePipelineServiceAsyncImpl
@@ -49,6 +50,11 @@ internal constructor(private val clientOptions: ClientOptions) : InferencePipeli
 
     override fun withRawResponse(): InferencePipelineServiceAsync.WithRawResponse = withRawResponse
 
+    override fun withOptions(
+        modifier: Consumer<ClientOptions.Builder>
+    ): InferencePipelineServiceAsync =
+        InferencePipelineServiceAsyncImpl(clientOptions.toBuilder().apply(modifier::accept).build())
+
     override fun data(): DataServiceAsync = data
 
     override fun rows(): RowServiceAsync = rows
@@ -93,6 +99,13 @@ internal constructor(private val clientOptions: ClientOptions) : InferencePipeli
             TestResultServiceAsyncImpl.WithRawResponseImpl(clientOptions)
         }
 
+        override fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): InferencePipelineServiceAsync.WithRawResponse =
+            InferencePipelineServiceAsyncImpl.WithRawResponseImpl(
+                clientOptions.toBuilder().apply(modifier::accept).build()
+            )
+
         override fun data(): DataServiceAsync.WithRawResponse = data
 
         override fun rows(): RowServiceAsync.WithRawResponse = rows

openlayer-java-core/src/main/kotlin/com/openlayer/api/services/async/ProjectServiceAsync.kt

@@ -2,6 +2,7 @@
 
 package com.openlayer.api.services.async
 
+import com.openlayer.api.core.ClientOptions
 import com.openlayer.api.core.RequestOptions
 import com.openlayer.api.core.http.HttpResponseFor
 import com.openlayer.api.models.projects.ProjectCreateParams
@@ -12,6 +13,7 @@ import com.openlayer.api.services.async.projects.CommitServiceAsync
 import com.openlayer.api.services.async.projects.InferencePipelineServiceAsync
 import com.openlayer.api.services.async.projects.TestServiceAsync
 import java.util.concurrent.CompletableFuture
+import java.util.function.Consumer
 
 interface ProjectServiceAsync {
 
@@ -20,6 +22,13 @@ interface ProjectServiceAsync {
      */
     fun withRawResponse(): WithRawResponse
 
+    /**
+     * Returns a view of this service with the given option modifications applied.
+     *
+     * The original service is not modified.
+     */
+    fun withOptions(modifier: Consumer<ClientOptions.Builder>): ProjectServiceAsync
+
     fun commits(): CommitServiceAsync
 
     fun inferencePipelines(): InferencePipelineServiceAsync
@@ -59,6 +68,15 @@ interface ProjectServiceAsync {
      */
     interface WithRawResponse {
 
+        /**
+         * Returns a view of this service with the given option modifications applied.
+         *
+         * The original service is not modified.
+         */
+        fun withOptions(
+            modifier: Consumer<ClientOptions.Builder>
+        ): ProjectServiceAsync.WithRawResponse
+
         fun commits(): CommitServiceAsync.WithRawResponse
 
         fun inferencePipelines(): InferencePipelineServiceAsync.WithRawResponse