Skip to content

Commit 134e615

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(client): allow providing some params positionally
1 parent ce52e15 commit 134e615

File tree

57 files changed

+1748
-316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1748
-316
lines changed

‎README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,6 @@ import com.openlayer.api.core.JsonValue;
456456
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
457457

458458
DataStreamParams params = DataStreamParams.builder()
459-
.inferencePipelineId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
460459
.config(DataStreamParams.Config.LlmData.builder()
461460
.addInputVariableName("user_query")
462461
.outputColumnName("output")

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ package com.openlayer.api.core
55
import com.fasterxml.jackson.core.Version
66
import com.fasterxml.jackson.core.util.VersionUtil
77

8+
fun checkRequired(name: String, condition: Boolean) =
9+
check(condition) { "`$name` is required, but was not set" }
10+
811
fun <T : Any> checkRequired(name: String, value: T?): T =
912
checkNotNull(value) { "`$name` is required, but was not set" }
1013

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

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,21 @@
33
package com.openlayer.api.models.commits
44

55
import com.openlayer.api.core.Params
6-
import com.openlayer.api.core.checkRequired
76
import com.openlayer.api.core.http.Headers
87
import com.openlayer.api.core.http.QueryParams
98
import java.util.Objects
9+
import java.util.Optional
10+
import kotlin.jvm.optionals.getOrNull
1011

1112
/** Retrieve a project version (commit) by its id. */
1213
class CommitRetrieveParams
1314
private constructor(
14-
private val projectVersionId: String,
15+
private val projectVersionId: String?,
1516
private val additionalHeaders: Headers,
1617
private val additionalQueryParams: QueryParams,
1718
) : Params {
1819

19-
fun projectVersionId(): String = projectVersionId
20+
fun projectVersionId(): Optional<String> = Optional.ofNullable(projectVersionId)
2021

2122
fun _additionalHeaders(): Headers = additionalHeaders
2223

@@ -26,14 +27,9 @@ private constructor(
2627

2728
companion object {
2829

29-
/**
30-
* Returns a mutable builder for constructing an instance of [CommitRetrieveParams].
31-
*
32-
* The following fields are required:
33-
* ```java
34-
* .projectVersionId()
35-
* ```
36-
*/
30+
@JvmStatic fun none(): CommitRetrieveParams = builder().build()
31+
32+
/** Returns a mutable builder for constructing an instance of [CommitRetrieveParams]. */
3733
@JvmStatic fun builder() = Builder()
3834
}
3935

@@ -51,10 +47,14 @@ private constructor(
5147
additionalQueryParams = commitRetrieveParams.additionalQueryParams.toBuilder()
5248
}
5349

54-
fun projectVersionId(projectVersionId: String) = apply {
50+
fun projectVersionId(projectVersionId: String?) = apply {
5551
this.projectVersionId = projectVersionId
5652
}
5753

54+
/** Alias for calling [Builder.projectVersionId] with `projectVersionId.orElse(null)`. */
55+
fun projectVersionId(projectVersionId: Optional<String>) =
56+
projectVersionId(projectVersionId.getOrNull())
57+
5858
fun additionalHeaders(additionalHeaders: Headers) = apply {
5959
this.additionalHeaders.clear()
6060
putAllAdditionalHeaders(additionalHeaders)
@@ -157,25 +157,18 @@ private constructor(
157157
* Returns an immutable instance of [CommitRetrieveParams].
158158
*
159159
* Further updates to this [Builder] will not mutate the returned instance.
160-
*
161-
* The following fields are required:
162-
* ```java
163-
* .projectVersionId()
164-
* ```
165-
*
166-
* @throws IllegalStateException if any required field is unset.
167160
*/
168161
fun build(): CommitRetrieveParams =
169162
CommitRetrieveParams(
170-
checkRequired("projectVersionId", projectVersionId),
163+
projectVersionId,
171164
additionalHeaders.build(),
172165
additionalQueryParams.build(),
173166
)
174167
}
175168

176169
fun _pathParam(index: Int): String =
177170
when (index) {
178-
0 -> projectVersionId
171+
0 -> projectVersionId ?: ""
179172
else -> ""
180173
}
181174

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

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import com.fasterxml.jackson.annotation.JsonCreator
66
import com.openlayer.api.core.Enum
77
import com.openlayer.api.core.JsonField
88
import com.openlayer.api.core.Params
9-
import com.openlayer.api.core.checkRequired
109
import com.openlayer.api.core.http.Headers
1110
import com.openlayer.api.core.http.QueryParams
1211
import com.openlayer.api.errors.OpenlayerInvalidDataException
@@ -17,7 +16,7 @@ import kotlin.jvm.optionals.getOrNull
1716
/** List the test results for a project commit (project version). */
1817
class TestResultListParams
1918
private constructor(
20-
private val projectVersionId: String,
19+
private val projectVersionId: String?,
2120
private val includeArchived: Boolean?,
2221
private val page: Long?,
2322
private val perPage: Long?,
@@ -27,7 +26,7 @@ private constructor(
2726
private val additionalQueryParams: QueryParams,
2827
) : Params {
2928

30-
fun projectVersionId(): String = projectVersionId
29+
fun projectVersionId(): Optional<String> = Optional.ofNullable(projectVersionId)
3130

3231
/** Filter for archived tests. */
3332
fun includeArchived(): Optional<Boolean> = Optional.ofNullable(includeArchived)
@@ -58,14 +57,9 @@ private constructor(
5857

5958
companion object {
6059

61-
/**
62-
* Returns a mutable builder for constructing an instance of [TestResultListParams].
63-
*
64-
* The following fields are required:
65-
* ```java
66-
* .projectVersionId()
67-
* ```
68-
*/
60+
@JvmStatic fun none(): TestResultListParams = builder().build()
61+
62+
/** Returns a mutable builder for constructing an instance of [TestResultListParams]. */
6963
@JvmStatic fun builder() = Builder()
7064
}
7165

@@ -93,10 +87,14 @@ private constructor(
9387
additionalQueryParams = testResultListParams.additionalQueryParams.toBuilder()
9488
}
9589

96-
fun projectVersionId(projectVersionId: String) = apply {
90+
fun projectVersionId(projectVersionId: String?) = apply {
9791
this.projectVersionId = projectVersionId
9892
}
9993

94+
/** Alias for calling [Builder.projectVersionId] with `projectVersionId.orElse(null)`. */
95+
fun projectVersionId(projectVersionId: Optional<String>) =
96+
projectVersionId(projectVersionId.getOrNull())
97+
10098
/** Filter for archived tests. */
10199
fun includeArchived(includeArchived: Boolean?) = apply {
102100
this.includeArchived = includeArchived
@@ -259,17 +257,10 @@ private constructor(
259257
* Returns an immutable instance of [TestResultListParams].
260258
*
261259
* Further updates to this [Builder] will not mutate the returned instance.
262-
*
263-
* The following fields are required:
264-
* ```java
265-
* .projectVersionId()
266-
* ```
267-
*
268-
* @throws IllegalStateException if any required field is unset.
269260
*/
270261
fun build(): TestResultListParams =
271262
TestResultListParams(
272-
checkRequired("projectVersionId", projectVersionId),
263+
projectVersionId,
273264
includeArchived,
274265
page,
275266
perPage,
@@ -282,7 +273,7 @@ private constructor(
282273

283274
fun _pathParam(index: Int): String =
284275
when (index) {
285-
0 -> projectVersionId
276+
0 -> projectVersionId ?: ""
286277
else -> ""
287278
}
288279

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

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ package com.openlayer.api.models.inferencepipelines
44

55
import com.openlayer.api.core.JsonValue
66
import com.openlayer.api.core.Params
7-
import com.openlayer.api.core.checkRequired
87
import com.openlayer.api.core.http.Headers
98
import com.openlayer.api.core.http.QueryParams
109
import com.openlayer.api.core.toImmutable
1110
import java.util.Objects
1211
import java.util.Optional
12+
import kotlin.jvm.optionals.getOrNull
1313

1414
/** Delete inference pipeline. */
1515
class InferencePipelineDeleteParams
1616
private constructor(
17-
private val inferencePipelineId: String,
17+
private val inferencePipelineId: String?,
1818
private val additionalHeaders: Headers,
1919
private val additionalQueryParams: QueryParams,
2020
private val additionalBodyProperties: Map<String, JsonValue>,
2121
) : Params {
2222

23-
fun inferencePipelineId(): String = inferencePipelineId
23+
fun inferencePipelineId(): Optional<String> = Optional.ofNullable(inferencePipelineId)
2424

2525
fun _additionalBodyProperties(): Map<String, JsonValue> = additionalBodyProperties
2626

@@ -32,14 +32,11 @@ private constructor(
3232

3333
companion object {
3434

35+
@JvmStatic fun none(): InferencePipelineDeleteParams = builder().build()
36+
3537
/**
3638
* Returns a mutable builder for constructing an instance of
3739
* [InferencePipelineDeleteParams].
38-
*
39-
* The following fields are required:
40-
* ```java
41-
* .inferencePipelineId()
42-
* ```
4340
*/
4441
@JvmStatic fun builder() = Builder()
4542
}
@@ -61,10 +58,16 @@ private constructor(
6158
inferencePipelineDeleteParams.additionalBodyProperties.toMutableMap()
6259
}
6360

64-
fun inferencePipelineId(inferencePipelineId: String) = apply {
61+
fun inferencePipelineId(inferencePipelineId: String?) = apply {
6562
this.inferencePipelineId = inferencePipelineId
6663
}
6764

65+
/**
66+
* Alias for calling [Builder.inferencePipelineId] with `inferencePipelineId.orElse(null)`.
67+
*/
68+
fun inferencePipelineId(inferencePipelineId: Optional<String>) =
69+
inferencePipelineId(inferencePipelineId.getOrNull())
70+
6871
fun additionalHeaders(additionalHeaders: Headers) = apply {
6972
this.additionalHeaders.clear()
7073
putAllAdditionalHeaders(additionalHeaders)
@@ -189,17 +192,10 @@ private constructor(
189192
* Returns an immutable instance of [InferencePipelineDeleteParams].
190193
*
191194
* Further updates to this [Builder] will not mutate the returned instance.
192-
*
193-
* The following fields are required:
194-
* ```java
195-
* .inferencePipelineId()
196-
* ```
197-
*
198-
* @throws IllegalStateException if any required field is unset.
199195
*/
200196
fun build(): InferencePipelineDeleteParams =
201197
InferencePipelineDeleteParams(
202-
checkRequired("inferencePipelineId", inferencePipelineId),
198+
inferencePipelineId,
203199
additionalHeaders.build(),
204200
additionalQueryParams.build(),
205201
additionalBodyProperties.toImmutable(),
@@ -211,7 +207,7 @@ private constructor(
211207

212208
fun _pathParam(index: Int): String =
213209
when (index) {
214-
0 -> inferencePipelineId
210+
0 -> inferencePipelineId ?: ""
215211
else -> ""
216212
}
217213

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

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import com.fasterxml.jackson.annotation.JsonCreator
66
import com.openlayer.api.core.Enum
77
import com.openlayer.api.core.JsonField
88
import com.openlayer.api.core.Params
9-
import com.openlayer.api.core.checkRequired
109
import com.openlayer.api.core.http.Headers
1110
import com.openlayer.api.core.http.QueryParams
1211
import com.openlayer.api.core.toImmutable
@@ -18,13 +17,13 @@ import kotlin.jvm.optionals.getOrNull
1817
/** Retrieve inference pipeline. */
1918
class InferencePipelineRetrieveParams
2019
private constructor(
21-
private val inferencePipelineId: String,
20+
private val inferencePipelineId: String?,
2221
private val expand: List<Expand>?,
2322
private val additionalHeaders: Headers,
2423
private val additionalQueryParams: QueryParams,
2524
) : Params {
2625

27-
fun inferencePipelineId(): String = inferencePipelineId
26+
fun inferencePipelineId(): Optional<String> = Optional.ofNullable(inferencePipelineId)
2827

2928
/** Expand specific nested objects. */
3029
fun expand(): Optional<List<Expand>> = Optional.ofNullable(expand)
@@ -37,14 +36,11 @@ private constructor(
3736

3837
companion object {
3938

39+
@JvmStatic fun none(): InferencePipelineRetrieveParams = builder().build()
40+
4041
/**
4142
* Returns a mutable builder for constructing an instance of
4243
* [InferencePipelineRetrieveParams].
43-
*
44-
* The following fields are required:
45-
* ```java
46-
* .inferencePipelineId()
47-
* ```
4844
*/
4945
@JvmStatic fun builder() = Builder()
5046
}
@@ -67,10 +63,16 @@ private constructor(
6763
inferencePipelineRetrieveParams.additionalQueryParams.toBuilder()
6864
}
6965

70-
fun inferencePipelineId(inferencePipelineId: String) = apply {
66+
fun inferencePipelineId(inferencePipelineId: String?) = apply {
7167
this.inferencePipelineId = inferencePipelineId
7268
}
7369

70+
/**
71+
* Alias for calling [Builder.inferencePipelineId] with `inferencePipelineId.orElse(null)`.
72+
*/
73+
fun inferencePipelineId(inferencePipelineId: Optional<String>) =
74+
inferencePipelineId(inferencePipelineId.getOrNull())
75+
7476
/** Expand specific nested objects. */
7577
fun expand(expand: List<Expand>?) = apply { this.expand = expand?.toMutableList() }
7678

@@ -188,17 +190,10 @@ private constructor(
188190
* Returns an immutable instance of [InferencePipelineRetrieveParams].
189191
*
190192
* Further updates to this [Builder] will not mutate the returned instance.
191-
*
192-
* The following fields are required:
193-
* ```java
194-
* .inferencePipelineId()
195-
* ```
196-
*
197-
* @throws IllegalStateException if any required field is unset.
198193
*/
199194
fun build(): InferencePipelineRetrieveParams =
200195
InferencePipelineRetrieveParams(
201-
checkRequired("inferencePipelineId", inferencePipelineId),
196+
inferencePipelineId,
202197
expand?.toImmutable(),
203198
additionalHeaders.build(),
204199
additionalQueryParams.build(),
@@ -207,7 +202,7 @@ private constructor(
207202

208203
fun _pathParam(index: Int): String =
209204
when (index) {
210-
0 -> inferencePipelineId
205+
0 -> inferencePipelineId ?: ""
211206
else -> ""
212207
}
213208

0 commit comments

Comments
 (0)