docs: add build method comments (#86)

Author: stainless-app[bot]

openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClient.kt

@@ -151,6 +151,11 @@ class OpenlayerOkHttpClient private constructor() {
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 
+        /**
+         * Returns an immutable instance of [OpenlayerClient].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): OpenlayerClient =
             OpenlayerClientImpl(
                 clientOptions

openlayer-java-client-okhttp/src/main/kotlin/com/openlayer/api/client/okhttp/OpenlayerOkHttpClientAsync.kt

@@ -153,6 +153,11 @@ class OpenlayerOkHttpClientAsync private constructor() {
 
         fun fromEnv() = apply { clientOptions.fromEnv() }
 
+        /**
+         * Returns an immutable instance of [OpenlayerClientAsync].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): OpenlayerClientAsync =
             OpenlayerClientAsyncImpl(
                 clientOptions

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

@@ -179,6 +179,18 @@ private constructor(
 
         fun fromEnv() = apply { System.getenv("OPENLAYER_API_KEY")?.let { apiKey(it) } }
 
+        /**
+         * Returns an immutable instance of [ClientOptions].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .httpClient()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): ClientOptions {
             val httpClient = checkRequired("httpClient", httpClient)
 

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

@@ -132,6 +132,11 @@ private constructor(
         /** Alias for calling [Builder.request] with `request.orElse(null)`. */
         fun request(request: Optional<Duration>) = request(request.getOrNull())
 
+        /**
+         * Returns an immutable instance of [Timeout].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): Timeout = Timeout(connect, read, write, request)
     }
 

openlayer-java-core/src/main/kotlin/com/openlayer/api/errors/OpenlayerError.kt

@@ -60,6 +60,11 @@ private constructor(
             keys.forEach(::removeAdditionalProperty)
         }
 
+        /**
+         * Returns an immutable instance of [OpenlayerError].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         */
         fun build(): OpenlayerError = OpenlayerError(additionalProperties.toImmutable())
     }
 

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/commits/CommitRetrieveParams.kt

@@ -166,6 +166,18 @@ private constructor(
             additionalQueryParams.removeAll(keys)
         }
 
+        /**
+         * Returns an immutable instance of [CommitRetrieveParams].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .projectVersionId()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): CommitRetrieveParams =
             CommitRetrieveParams(
                 checkRequired("projectVersionId", projectVersionId),

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/commits/CommitRetrieveResponse.kt

@@ -737,6 +737,31 @@ private constructor(
             keys.forEach(::removeAdditionalProperty)
         }
 
+        /**
+         * Returns an immutable instance of [CommitRetrieveResponse].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .id()
+         * .commit()
+         * .dateArchived()
+         * .dateCreated()
+         * .failingGoalCount()
+         * .mlModelId()
+         * .passingGoalCount()
+         * .projectId()
+         * .status()
+         * .statusMessage()
+         * .storageUri()
+         * .totalGoalCount()
+         * .trainingDatasetId()
+         * .validationDatasetId()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): CommitRetrieveResponse =
             CommitRetrieveResponse(
                 checkRequired("id", id),
@@ -1293,6 +1318,25 @@ private constructor(
                 keys.forEach(::removeAdditionalProperty)
             }
 
+            /**
+             * Returns an immutable instance of [Commit].
+             *
+             * Further updates to this [Builder] will not mutate the returned instance.
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * .authorId()
+             * .fileSize()
+             * .message()
+             * .mlModelId()
+             * .storageUri()
+             * .trainingDatasetId()
+             * .validationDatasetId()
+             * ```
+             *
+             * @throws IllegalStateException if any required field is unset.
+             */
             fun build(): Commit =
                 Commit(
                     checkRequired("id", id),
@@ -1551,6 +1595,18 @@ private constructor(
                 keys.forEach(::removeAdditionalProperty)
             }
 
+            /**
+             * Returns an immutable instance of [Links].
+             *
+             * Further updates to this [Builder] will not mutate the returned instance.
+             *
+             * The following fields are required:
+             * ```java
+             * .app()
+             * ```
+             *
+             * @throws IllegalStateException if any required field is unset.
+             */
             fun build(): Links =
                 Links(checkRequired("app", app), additionalProperties.toImmutable())
         }

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/commits/testresults/TestResultListParams.kt

@@ -277,6 +277,18 @@ private constructor(
             additionalQueryParams.removeAll(keys)
         }
 
+        /**
+         * Returns an immutable instance of [TestResultListParams].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .projectVersionId()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): TestResultListParams =
             TestResultListParams(
                 checkRequired("projectVersionId", projectVersionId),

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/commits/testresults/TestResultListResponse.kt

@@ -139,6 +139,18 @@ private constructor(
             keys.forEach(::removeAdditionalProperty)
         }
 
+        /**
+         * Returns an immutable instance of [TestResultListResponse].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .items()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): TestResultListResponse =
             TestResultListResponse(
                 checkRequired("items", items).map { it.toImmutable() },
@@ -647,6 +659,26 @@ private constructor(
                 keys.forEach(::removeAdditionalProperty)
             }
 
+            /**
+             * Returns an immutable instance of [Item].
+             *
+             * Further updates to this [Builder] will not mutate the returned instance.
+             *
+             * The following fields are required:
+             * ```java
+             * .id()
+             * .dateCreated()
+             * .dateDataEnds()
+             * .dateDataStarts()
+             * .dateUpdated()
+             * .inferencePipelineId()
+             * .projectVersionId()
+             * .status()
+             * .statusMessage()
+             * ```
+             *
+             * @throws IllegalStateException if any required field is unset.
+             */
             fun build(): Item =
                 Item(
                     checkRequired("id", id),
@@ -1725,6 +1757,31 @@ private constructor(
                     keys.forEach(::removeAdditionalProperty)
                 }
 
+                /**
+                 * Returns an immutable instance of [Goal].
+                 *
+                 * Further updates to this [Builder] will not mutate the returned instance.
+                 *
+                 * The following fields are required:
+                 * ```java
+                 * .id()
+                 * .commentCount()
+                 * .creatorId()
+                 * .dateArchived()
+                 * .dateCreated()
+                 * .dateUpdated()
+                 * .description()
+                 * .name()
+                 * .number()
+                 * .originProjectVersionId()
+                 * .subtype()
+                 * .suggested()
+                 * .thresholds()
+                 * .type()
+                 * ```
+                 *
+                 * @throws IllegalStateException if any required field is unset.
+                 */
                 fun build(): Goal =
                     Goal(
                         checkRequired("id", id),
@@ -2025,6 +2082,11 @@ private constructor(
                         keys.forEach(::removeAdditionalProperty)
                     }
 
+                    /**
+                     * Returns an immutable instance of [Threshold].
+                     *
+                     * Further updates to this [Builder] will not mutate the returned instance.
+                     */
                     fun build(): Threshold =
                         Threshold(
                             insightName,

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/inferencepipelines/InferencePipelineDeleteParams.kt

@@ -202,6 +202,18 @@ private constructor(
             keys.forEach(::removeAdditionalBodyProperty)
         }
 
+        /**
+         * Returns an immutable instance of [InferencePipelineDeleteParams].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .inferencePipelineId()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): InferencePipelineDeleteParams =
             InferencePipelineDeleteParams(
                 checkRequired("inferencePipelineId", inferencePipelineId),

openlayer-java-core/src/main/kotlin/com/openlayer/api/models/inferencepipelines/InferencePipelineRetrieveParams.kt

@@ -202,6 +202,18 @@ private constructor(
             additionalQueryParams.removeAll(keys)
         }
 
+        /**
+         * Returns an immutable instance of [InferencePipelineRetrieveParams].
+         *
+         * Further updates to this [Builder] will not mutate the returned instance.
+         *
+         * The following fields are required:
+         * ```java
+         * .inferencePipelineId()
+         * ```
+         *
+         * @throws IllegalStateException if any required field is unset.
+         */
         fun build(): InferencePipelineRetrieveParams =
             InferencePipelineRetrieveParams(
                 checkRequired("inferencePipelineId", inferencePipelineId),