Bump GE API spec version to 2023.4 #132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Generated API diffdiff -ur ./base-ref-api/.openapi-generator/FILES ./pr-ref-api/.openapi-generator/FILES
--- ./base-ref-api/.openapi-generator/FILES 2024-01-04 18:45:33.047407744 +0000
+++ ./pr-ref-api/.openapi-generator/FILES 2024-01-04 18:45:18.959305453 +0000
@@ -1,8 +1,10 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildCacheApi.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/DevelocityApi.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/MetaApi.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/ProjectsApi.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestsApi.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/auth/HttpBearerAuth.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/infrastructure/BigDecimalAdapter.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/infrastructure/BigIntegerAdapter.kt
@@ -16,12 +18,26 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/infrastructure/URIAdapter.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/infrastructure/UUIDAdapter.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/ApiProblem.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BazelWorkUnit.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/Build.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesEnvironment.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesLink.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesValue.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelName.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelQuery.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModels.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsGradleAttributes.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsGradleBuildCachePerformance.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsGradleNetworkActivity.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsGradleProjects.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsMavenAttributes.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsMavenBuildCachePerformance.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsMavenDependencyResolution.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildModelsMavenModules.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildQuery.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildScanIdsByOutcome.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildsQuery.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/DevelocityVersion.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleAttributes.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceAvoidanceSavingsSummary.kt
@@ -29,12 +45,18 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceBuildCacheOverhead.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceBuildCacheRemoteInfo.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceBuildCaches.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskAvoidanceSavingsSummary.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskFingerprintingSummary.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceWorkUnitAvoidanceSavingsSummary.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceWorkUnitFingerprintingSummary.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildOptions.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleDevelocitySettings.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleEnterpriseVersion.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleGradleEnterpriseSettings.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleNetworkActivity.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleProject.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleWorkUnit.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/KeySecretPair.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenAttributes.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformance.kt
@@ -46,8 +68,11 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalFingerprintingSummary.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildOptions.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenDependencyResolution.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenDevelocitySettings.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenGradleEnterpriseSettings.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenModule.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenWorkUnit.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/NodeConfiguration.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/PageMetadata.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/PageQuery.kt
@@ -57,6 +82,8 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/ProjectReference.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/ProjectsPage.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/ReplicationConfiguration.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestCasesQuery.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestContainersQuery.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionAgentPoolConfiguration.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionAgentPoolConfigurationWithId.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionAgentPoolPage.kt
@@ -65,3 +92,9 @@
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyDescription.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt
src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefixPage.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestIncludeFields.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestOrContainer.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestOutcome.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestOutcomeDistribution.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestWorkUnit.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestsResponse.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildCacheApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildCacheApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildCacheApi.kt 2024-01-04 18:45:33.303408214 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildCacheApi.kt 2024-01-04 18:45:19.251306025 +0000
@@ -12,7 +12,7 @@
interface BuildCacheApi {
/**
* Create or update a Build Cache Node.
- * Create a new Build Cache Node in Gradle Enterprise or update the configuration of an existing one. The Built-in Build Cache Node cannot be named as the target of this operation.
+ * Create a new Build Cache Node in Develocity or update the configuration of an existing one. The Built-in Build Cache Node cannot be named as the target of this operation.
* Responses:
* - 200: The name referenced an existing Build Cache Node and that Build Cache Node’s configuration was updated successfully.
* - 201: A new Build Cache Node was created with the configuration specified in the request.
@@ -47,7 +47,7 @@
* - 202: Purging the Build Cache Node was successfully initiated.
* - 404: The referenced resource either does not exist or the permissions to know about it are missing.
* - 500: The server encountered an unexpected error.
- * - 503: The node was not signed in with Gradle Enterprise.
+ * - 503: The node was not signed in with Develocity.
*
* @param name The name of the Build Cache Node. To select the Built-in Build Cache Node, use `Built-in` as name.
* @return [Unit]
@@ -57,7 +57,7 @@
/**
* Regenerate the secret of a Build Cache Node.
- * Regenerates the secret associated with the named Build Cache Node. The old secret expires immediately, causing the Build Cache Node to disconnect from Gradle Enterprise. The Built-in Build Cache Node cannot be named as the target of this operation.
+ * Regenerates the secret associated with the named Build Cache Node. The old secret expires immediately, causing the Build Cache Node to disconnect from Develocity. The Built-in Build Cache Node cannot be named as the target of this operation.
* Responses:
* - 200: The name referenced an existing Build Cache Node and that Build Cache Node's secret was regenerated.
* - 404: The referenced resource either does not exist or the permissions to know about it are missing.
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt 2024-01-04 18:45:33.307408222 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt 2024-01-04 18:45:19.251306025 +0000
@@ -21,15 +21,16 @@
* - 503: The server is not ready to handle the request.
*
* @param id The Build Scan ID.
+ * @param models The list of build models to return in the response for each build. If not provided, no models are returned. (optional)
* @param availabilityWaitTimeoutSecs The time in seconds the server should wait for ingestion before returning a wait timeout response. (optional)
* @return [Build]
*/
@GET("api/builds/{id}")
- suspend fun getBuild(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): Build
+ suspend fun getBuild(@Path("id") id: kotlin.String, @Query("models") models: kotlin.collections.List<BuildModelName>? = null, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): Build
/**
* Get a list of builds with the common attributes of a Build Scan.
- * The contained attributes are build tool agnostic. If none of `fromInstant`, `fromBuild`, or `reverse` is used, when making a request to this endpoint, it will return builds that were received and processed by Gradle Enterprise after the request was made.
+ * The contained attributes are build tool agnostic. If none of `fromInstant`, `fromBuild`, or `reverse` is used, when making a request to this endpoint, it will return builds that were received and processed by Develocity after the request was made.
* Responses:
* - 200: A list of builds with the common attributes of a Build Scan.
* - 400: The request cannot be fulfilled due to a problem.
@@ -37,18 +38,19 @@
* - 500: The server encountered an unexpected error.
* - 503: The server is not ready to handle the request.
*
- * @param since **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used. (optional)
- * @param sinceBuild **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used. (optional)
- * @param fromInstant A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if `fromBuild` is used. (optional)
- * @param fromBuild A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid. (optional)
+ * @param since **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used. (optional)
+ * @param sinceBuild **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used. (optional)
+ * @param fromInstant A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if `fromBuild` is used. (optional)
+ * @param fromBuild A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid. (optional)
* @param reverse A boolean indicating the time direction of the query. A value of `true` indicates a backward query, and returned builds will be sorted from most to least recent. A value of `false` indicates a forward query, and returned builds will be sorted from least to most recent. This parameter has no effect if any of `since`, `sinceBuild` are used. If not provided, the default value is `false`. (optional)
* @param maxBuilds The maximum number of builds returned by the query. The query returns when that number is reached or when `maxWaitSecs` is reached. If not provided, the default value is `100`. (optional)
* @param maxWaitSecs The maximum number of seconds to wait for builds before returning. If this time is reached before `maxBuilds` is reached, the query returns with the already processed builds. Note that this time is respected with best effort. A query will return soon after this time has passed but there is no guarantee that it exactly returns before this time has passed. This parameter has no effect if `reverse=true` is specified, because new builds cannot become available in the past. If not provided, the default value is `3`. (optional)
- * @param query A query for filtering builds, written in the Gradle Enterprise advanced query language See: https://gradle.com/help/enterprise-advanced-query (optional)
+ * @param query A query for filtering builds, written in the Develocity advanced search query language See: https://gradle.com/help/enterprise-advanced-search (optional)
+ * @param models The list of build models to return in the response for each build. If not provided, no models are returned. (optional)
* @return [kotlin.collections.List<Build>]
*/
@GET("api/builds")
- suspend fun getBuilds(@Query("since") since: kotlin.Long? = null, @Query("sinceBuild") sinceBuild: kotlin.String? = null, @Query("fromInstant") fromInstant: kotlin.Long? = null, @Query("fromBuild") fromBuild: kotlin.String? = null, @Query("reverse") reverse: kotlin.Boolean? = null, @Query("maxBuilds") maxBuilds: kotlin.Int? = null, @Query("maxWaitSecs") maxWaitSecs: kotlin.Int? = null, @Query("query") query: kotlin.String? = null): kotlin.collections.List<Build>
+ suspend fun getBuilds(@Query("since") since: kotlin.Long? = null, @Query("sinceBuild") sinceBuild: kotlin.String? = null, @Query("fromInstant") fromInstant: kotlin.Long? = null, @Query("fromBuild") fromBuild: kotlin.String? = null, @Query("reverse") reverse: kotlin.Boolean? = null, @Query("maxBuilds") maxBuilds: kotlin.Int? = null, @Query("maxWaitSecs") maxWaitSecs: kotlin.Int? = null, @Query("query") query: kotlin.String? = null, @Query("models") models: kotlin.collections.List<BuildModelName>? = null): kotlin.collections.List<Build>
/**
* Get the attributes of a Gradle Build Scan.
@@ -85,6 +87,23 @@
suspend fun getGradleBuildCachePerformance(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleBuildCachePerformance
/**
+ * Get the network activity of a Gradle Build Scan.
+ * This model is Gradle specific and cannot be requested for another build tool. This model is only available starting with Gradle version 3.5 and Develocity Gradle Plugin version 1.6.
+ * Responses:
+ * - 200: The network activity of a Gradle Build Scan.
+ * - 400: The request cannot be fulfilled due to a problem.
+ * - 404: The referenced resource either does not exist or the permissions to know about it are missing.
+ * - 500: The server encountered an unexpected error.
+ * - 503: The server is not ready to handle the request.
+ *
+ * @param id The Build Scan ID.
+ * @param availabilityWaitTimeoutSecs The time in seconds the server should wait for ingestion before returning a wait timeout response. (optional)
+ * @return [GradleNetworkActivity]
+ */
+ @GET("api/builds/{id}/gradle-network-activity")
+ suspend fun getGradleNetworkActivity(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleNetworkActivity
+
+ /**
* Get the projects of a Gradle Build Scan.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
@@ -136,6 +155,23 @@
suspend fun getMavenBuildCachePerformance(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenBuildCachePerformance
/**
+ * Get information about the dependency resolution of a Maven Build Scan.
+ * This model is Maven specific and cannot be requested for another build tool. This model is only available starting with the Develocity Maven Extension version 1.9.
+ * Responses:
+ * - 200: Information about the dependency resolution of a Maven Build Scan.
+ * - 400: The request cannot be fulfilled due to a problem.
+ * - 404: The referenced resource either does not exist or the permissions to know about it are missing.
+ * - 500: The server encountered an unexpected error.
+ * - 503: The server is not ready to handle the request.
+ *
+ * @param id The Build Scan ID.
+ * @param availabilityWaitTimeoutSecs The time in seconds the server should wait for ingestion before returning a wait timeout response. (optional)
+ * @return [MavenDependencyResolution]
+ */
+ @GET("api/builds/{id}/maven-dependency-resolution")
+ suspend fun getMavenDependencyResolution(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenDependencyResolution
+
+ /**
* Get the modules of a Maven Build Scan.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api: DevelocityApi.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/MetaApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/MetaApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/MetaApi.kt 2024-01-04 18:45:33.307408222 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/MetaApi.kt 2024-01-04 18:45:19.255306031 +0000
@@ -11,16 +11,16 @@
@JvmSuppressWildcards
interface MetaApi {
/**
- * Provides the version of Gradle Enterprise.
+ * Provides the version of Develocity.
* This endpoint can be accessed by any authenticated user.
* Responses:
- * - 200: The version of Gradle Enterprise.
+ * - 200: Successful version response
* - 404: The referenced resource either does not exist or the permissions to know about it are missing.
* - 500: The server encountered an unexpected error.
*
- * @return [GradleEnterpriseVersion]
+ * @return [DevelocityVersion]
*/
@GET("api/version")
- suspend fun getVersion(): GradleEnterpriseVersion
+ suspend fun getVersion(): DevelocityVersion
}
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/ProjectsApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/ProjectsApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/ProjectsApi.kt 2024-01-04 18:45:33.307408222 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/ProjectsApi.kt 2024-01-04 18:45:19.255306031 +0000
@@ -12,7 +12,7 @@
interface ProjectsApi {
/**
* Create or update a project.
- * **<mark>Beta:</mark>** Create a new project in Gradle Enterprise or update an existing project. When updating, any optional fields that are omitted from the request, but were previously set on the project, will be unset/removed. An existing project's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response.
+ * **<mark>Beta:</mark>** Create a new project in Develocity or update an existing project. When updating, any optional fields that are omitted from the request, but were previously set on the project, will be unset/removed. An existing project's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response.
* Responses:
* - 200: The project was created or it was updated successfully.
* - 400: The request body is malformed or contains invalid values for at least one of the properties.
@@ -28,7 +28,7 @@
/**
* Create or update a project group.
- * **<mark>Beta:</mark>** Create a new project group in Gradle Enterprise or update an existing project group. When updating, any optional fields that are omitted from the request, but were previously set on the project group, will be unset/removed. An existing project group's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response.
+ * **<mark>Beta:</mark>** Create a new project group in Develocity or update an existing project group. When updating, any optional fields that are omitted from the request, but were previously set on the project group, will be unset/removed. An existing project group's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response.
* Responses:
* - 200: The project group was created or it was updated successfully.
* - 400: The request body is malformed or contains invalid values for at least one of the properties.
@@ -103,7 +103,7 @@
* Lists Projects.
* **<mark>Beta:</mark>** Returns a paged list of all projects. If there are a lot of projects, then all pages will need to be retrieved in order to retrieve the full list of projects. The default number of projects per page is 1,000.
* Responses:
- * - 200: A list of projects known to Gradle Enterprise.
+ * - 200: A list of projects known to Develocity.
* - 403: The authenticated user has insufficient permissions.
* - 404: No API key was specified in the request, the key has been revoked or the user bearing the key lacks permissions for this operation.
*
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt 2024-01-04 18:45:33.307408222 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt 2024-01-04 18:45:19.255306031 +0000
@@ -12,7 +12,7 @@
interface TestDistributionApi {
/**
* Create or update an Agent Pool.
- * Create a new Agent Pool in Gradle Enterprise or update the configuration of an existing one. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be either added last on creation, or will not change position on update. When specified, the Agent Pool will be added at/moved to the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly.
+ * Create a new Agent Pool in Develocity or update the configuration of an existing one. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be either added last on creation, or will not change position on update. When specified, the Agent Pool will be added at/moved to the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly.
* Responses:
* - 200: The Agent Pool was created or its configuration was updated successfully.
* - 400: The request body is malformed or contains invalid values for at least one of the properties.
@@ -28,7 +28,7 @@
/**
* Create an Agent Pool.
- * Create a new Agent Pool in Gradle Enterprise. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be added last. When specified, the Agent Pool will be added at the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly.
+ * Create a new Agent Pool in Develocity. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be added last. When specified, the Agent Pool will be added at the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly.
* Responses:
* - 200: A new Agent Pool was created with the configuration specified in the request.
* - 400: The request body is malformed or contains invalid values for at least one of the properties.
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api: TestsApi.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BazelWorkUnit.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/Build.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/Build.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/Build.kt 2024-01-04 18:45:32.363406489 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/Build.kt 2024-01-04 18:45:19.263306048 +0000
@@ -15,6 +15,7 @@
package com.gabrielfeo.gradle.enterprise.api.model
+import com.gabrielfeo.gradle.enterprise.api.model.*
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
@@ -23,10 +24,11 @@
* A build with the common attributes of a Build Scan.
*
* @param id The Build Scan ID.
- * @param availableAt A unix-epoch-time in milliseconds referring to the instant that Gradle Enterprise completed receiving and processing the build.
+ * @param availableAt A unix-epoch-time in milliseconds referring to the instant that Develocity completed receiving and processing the build.
* @param buildToolType The build tool type used to capture the Build Scan.
* @param buildToolVersion The build tool version used.
* @param buildAgentVersion The build agent version used.
+ * @param models
*/
@@ -36,7 +38,7 @@
@Json(name = "id")
val id: kotlin.String,
- /* A unix-epoch-time in milliseconds referring to the instant that Gradle Enterprise completed receiving and processing the build. */
+ /* A unix-epoch-time in milliseconds referring to the instant that Develocity completed receiving and processing the build. */
@Json(name = "availableAt")
val availableAt: kotlin.Long,
@@ -50,7 +52,10 @@
/* The build agent version used. */
@Json(name = "buildAgentVersion")
- val buildAgentVersion: kotlin.String
+ val buildAgentVersion: kotlin.String,
+
+ @Json(name = "models")
+ val models: BuildModels? = null
)
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesEnvironment.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesEnvironment.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesEnvironment.kt 2024-01-04 18:45:32.383406527 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesEnvironment.kt 2024-01-04 18:45:18.139303851 +0000
@@ -20,19 +20,19 @@
import com.squareup.moshi.JsonClass
/**
- * The environment where the build has been executed.
+ * The environment where the build is executed.
*
* @param operatingSystem Operating system of the build machine.
* @param numberOfCpuCores Number of cores available to the build JVM.
- * @param jreVersion Version of the Java runtime that executed the build.
- * @param jvmVersion Version of the Java Virtual Machine that executed the build.
+ * @param jreVersion Version of the Java runtime executing the build.
+ * @param jvmVersion Version of the Java Virtual Machine executing the build.
* @param jvmMaxMemoryHeapSize Maximum heap memory available to the build JVM in bytes.
- * @param jvmLocale The locale of the JVM that executed the build.
- * @param username Operating system username of the build user. May be `null` if no username was captured.
- * @param jvmCharset The default charset of the JVM that executed the build. May be `null` if capturing was not possible.
- * @param publicHostname The hostname of the build machine, as seen on the network. May be `null` if capturing was not possible.
- * @param localHostname The hostname of the build machine, as specified by itself. May be `null` if capturing was not possible.
- * @param localIpAddresses The local IP addresses of the build machine. May be `null` if capturing was not possible.
+ * @param jvmLocale The locale of the JVM executing the build.
+ * @param username Operating system username of the build user. `null` if no username is captured.
+ * @param jvmCharset The default charset of the JVM executing the build. `null` if capturing is not possible.
+ * @param publicHostname The hostname of the build machine, as seen on the network. `null` if capturing is not possible.
+ * @param localHostname The hostname of the build machine, as specified by itself. `null` if capturing is not possible.
+ * @param localIpAddresses The local IP addresses of the build machine. `null` if capturing is not possible.
*/
@@ -46,11 +46,11 @@
@Json(name = "numberOfCpuCores")
val numberOfCpuCores: kotlin.Int,
- /* Version of the Java runtime that executed the build. */
+ /* Version of the Java runtime executing the build. */
@Json(name = "jreVersion")
val jreVersion: kotlin.String,
- /* Version of the Java Virtual Machine that executed the build. */
+ /* Version of the Java Virtual Machine executing the build. */
@Json(name = "jvmVersion")
val jvmVersion: kotlin.String,
@@ -58,27 +58,27 @@
@Json(name = "jvmMaxMemoryHeapSize")
val jvmMaxMemoryHeapSize: kotlin.Long,
- /* The locale of the JVM that executed the build. */
+ /* The locale of the JVM executing the build. */
@Json(name = "jvmLocale")
val jvmLocale: kotlin.String,
- /* Operating system username of the build user. May be `null` if no username was captured. */
+ /* Operating system username of the build user. `null` if no username is captured. */
@Json(name = "username")
val username: kotlin.String? = null,
- /* The default charset of the JVM that executed the build. May be `null` if capturing was not possible. */
+ /* The default charset of the JVM executing the build. `null` if capturing is not possible. */
@Json(name = "jvmCharset")
val jvmCharset: kotlin.String? = null,
- /* The hostname of the build machine, as seen on the network. May be `null` if capturing was not possible. */
+ /* The hostname of the build machine, as seen on the network. `null` if capturing is not possible. */
@Json(name = "publicHostname")
val publicHostname: kotlin.String? = null,
- /* The hostname of the build machine, as specified by itself. May be `null` if capturing was not possible. */
+ /* The hostname of the build machine, as specified by itself. `null` if capturing is not possible. */
@Json(name = "localHostname")
val localHostname: kotlin.String? = null,
- /* The local IP addresses of the build machine. May be `null` if capturing was not possible. */
+ /* The local IP addresses of the build machine. `null` if capturing is not possible. */
@Json(name = "localIpAddresses")
val localIpAddresses: kotlin.collections.List<kotlin.String>? = null
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesValue.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesValue.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesValue.kt 2024-01-04 18:45:32.407406570 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildAttributesValue.kt 2024-01-04 18:45:18.163303897 +0000
@@ -23,7 +23,7 @@
* A Build Scan value.
*
* @param name The name of the Build Scan value.
- * @param `value` The value of the Build Scan value. May be `null` if the Build Scan value is not set.
+ * @param `value` The value of the Build Scan value. `null` if the Build Scan value is not set.
*/
@@ -33,7 +33,7 @@
@Json(name = "name")
val name: kotlin.String,
- /* The value of the Build Scan value. May be `null` if the Build Scan value is not set. */
+ /* The value of the Build Scan value. `null` if the Build Scan value is not set. */
@Json(name = "value")
val `value`: kotlin.String? = null
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelName.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelQuery.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModels.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsGradleAttributes.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsGradleBuildCachePerformance.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsGradleNetworkActivity.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsGradleProjects.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsMavenAttributes.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsMavenBuildCachePerformance.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsMavenDependencyResolution.kt
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildModelsMavenModules.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildQuery.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildQuery.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildQuery.kt 2024-01-04 18:45:32.415406585 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildQuery.kt 2024-01-04 18:45:19.267306055 +0000
@@ -15,6 +15,7 @@
package com.gabrielfeo.gradle.enterprise.api.model
+import com.gabrielfeo.gradle.enterprise.api.model.*
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
@@ -22,12 +23,17 @@
/**
*
*
+ * @param models The list of build models to return in the response for each build. If not provided, no models are returned.
* @param availabilityWaitTimeoutSecs The time in seconds the server should wait for ingestion before returning a wait timeout response.
*/
data class BuildQuery (
+ /* The list of build models to return in the response for each build. If not provided, no models are returned. */
+ @Json(name = "models")
+ val models: kotlin.collections.List<BuildModelName>? = null,
+
/* The time in seconds the server should wait for ingestion before returning a wait timeout response. */
@Json(name = "availabilityWaitTimeoutSecs")
val availabilityWaitTimeoutSecs: kotlin.Int? = null
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: BuildScanIdsByOutcome.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildsQuery.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildsQuery.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildsQuery.kt 2024-01-04 18:45:32.419406593 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/BuildsQuery.kt 2024-01-04 18:45:19.267306055 +0000
@@ -15,6 +15,7 @@
package com.gabrielfeo.gradle.enterprise.api.model
+import com.gabrielfeo.gradle.enterprise.api.model.*
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
@@ -22,34 +23,35 @@
/**
*
*
- * @param since **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used.
- * @param sinceBuild **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used.
- * @param fromInstant A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if `fromBuild` is used.
- * @param fromBuild A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid.
+ * @param since **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used.
+ * @param sinceBuild **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used.
+ * @param fromInstant A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if `fromBuild` is used.
+ * @param fromBuild A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid.
* @param reverse A boolean indicating the time direction of the query. A value of `true` indicates a backward query, and returned builds will be sorted from most to least recent. A value of `false` indicates a forward query, and returned builds will be sorted from least to most recent. This parameter has no effect if any of `since`, `sinceBuild` are used. If not provided, the default value is `false`.
* @param maxBuilds The maximum number of builds returned by the query. The query returns when that number is reached or when `maxWaitSecs` is reached. If not provided, the default value is `100`.
* @param maxWaitSecs The maximum number of seconds to wait for builds before returning. If this time is reached before `maxBuilds` is reached, the query returns with the already processed builds. Note that this time is respected with best effort. A query will return soon after this time has passed but there is no guarantee that it exactly returns before this time has passed. This parameter has no effect if `reverse=true` is specified, because new builds cannot become available in the past. If not provided, the default value is `3`.
- * @param query A query for filtering builds, written in the Gradle Enterprise advanced query language See: https://gradle.com/help/enterprise-advanced-query
+ * @param query A query for filtering builds, written in the Develocity advanced search query language See: https://gradle.com/help/enterprise-advanced-search
+ * @param models The list of build models to return in the response for each build. If not provided, no models are returned.
*/
data class BuildsQuery (
- /* **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used. */
+ /* **This parameter is deprecated, use `fromInstant` instead.** A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant. This parameter can only be used with `reverse=false`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if any of `sinceBuild`, `fromInstant`, `fromBuild` are used. */
@Json(name = "since")
@Deprecated(message = "This property is deprecated.")
val since: kotlin.Long? = null,
- /* **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used. */
+ /* **This parameter is deprecated, use `fromBuild` instead.** A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it). This parameter can only be used with `reverse=false`. This parameter has precedence over any value set for the `since` parameter. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid. This parameter has no effect if any of `fromInstant`, `fromBuild` are used. */
@Json(name = "sinceBuild")
@Deprecated(message = "This property is deprecated.")
val sinceBuild: kotlin.String? = null,
- /* A unix-epoch-time in milliseconds allowing to retrieve builds for which Gradle Enterprise completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Gradle Enterprise instance will be used. This parameter has no effect if `fromBuild` is used. */
+ /* A unix-epoch-time in milliseconds allowing to retrieve builds for which Develocity completed receiving and processing the build after this instant when used in conjunction with `reverse=false`, or before this instant when used in conjunction with `reverse=true`. Therefore, a value of `0` will process all builds. If not provided, the time in milliseconds when the request is received by the Develocity instance will be used. This parameter has no effect if `fromBuild` is used. */
@Json(name = "fromInstant")
val fromInstant: kotlin.Long? = null,
- /* A Build Scan ID allowing to retrieve builds for which Gradle Enterprise completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Gradle Enterprise instance. A Build Scan ID for a deleted build is valid. */
+ /* A Build Scan ID allowing to retrieve builds for which Develocity completed receiving and processing after the given Build Scan ID (excluding it) when used in conjunction with `reverse=false`, or before the given Build Scan ID (excluding it) when used in conjunction with `reverse=true`. This parameter has precedence over any value set for the `since`, `sinceBuild`, `fromInstant` parameters. A valid Build Scan ID must be provided, that is, a Build Scan ID that exists in the Develocity instance. A Build Scan ID for a deleted build is valid. */
@Json(name = "fromBuild")
val fromBuild: kotlin.String? = null,
@@ -65,9 +67,13 @@
@Json(name = "maxWaitSecs")
val maxWaitSecs: kotlin.Int? = null,
- /* A query for filtering builds, written in the Gradle Enterprise advanced query language See: https://gradle.com/help/enterprise-advanced-query */
+ /* A query for filtering builds, written in the Develocity advanced search query language See: https://gradle.com/help/enterprise-advanced-search */
@Json(name = "query")
- val query: kotlin.String? = null
+ val query: kotlin.String? = null,
+
+ /* The list of build models to return in the response for each build. If not provided, no models are returned. */
+ @Json(name = "models")
+ val models: kotlin.collections.List<BuildModelName>? = null
)
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: DevelocityVersion.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleAttributes.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleAttributes.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleAttributes.kt 2024-01-04 18:45:33.315408237 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleAttributes.kt 2024-01-04 18:45:19.271306063 +0000
@@ -24,20 +24,21 @@
* The attributes of a Gradle Build Scan.
*
* @param id The Build Scan ID.
- * @param buildStartTime The time when the build started, as milliseconds since Epoch.
+ * @param buildStartTime The time when the build starts, as milliseconds since Epoch.
* @param buildDuration The duration of the build, as milliseconds since Epoch.
* @param gradleVersion The Gradle version used.
- * @param pluginVersion The Gradle Enterprise Gradle plugin version used.
+ * @param pluginVersion The Develocity Gradle plugin version used.
* @param requestedTasks The list of requested tasks.
- * @param hasFailed True when the build failed, false otherwise.
+ * @param hasFailed True when the build fails, false otherwise.
* @param tags The list of Build Scan tags.
* @param propertyValues The list of Build Scan values.
* @param links The list of Build Scan links.
* @param gradleEnterpriseSettings
+ * @param develocitySettings
* @param buildOptions
* @param environment
- * @param rootProjectName The root project name. May be `null` in case of very early build failure.
- * @param hasVerificationFailure Set only if the build failed: true when the build has at least one failure classified as \"Verification\", false otherwise. The Verification classification is meant for failures that are expected within a standard application development lifecycle. They typically represent a problem with the developer’s inputs to the build such as the source code.
+ * @param rootProjectName The root project name. `null` in case of very early build failure.
+ * @param hasVerificationFailure Set only if the build fails: true when the build has at least one failure classified as \"Verification\", false otherwise. The Verification classification is meant for failures that are expected within a standard application development lifecycle. They typically represent a problem with the developer’s inputs to the build such as the source code.
* @param hasNonVerificationFailure Set only if the build failed: true when the build has at least one failure classified as \"Non-verification\", false otherwise. The Non-verification classification is meant for failures that are typically not expected within a standard application development lifecycle, such as build configuration failures, dependency resolution failures, and infrastructure failures.
*/
@@ -48,7 +49,7 @@
@Json(name = "id")
val id: kotlin.String,
- /* The time when the build started, as milliseconds since Epoch. */
+ /* The time when the build starts, as milliseconds since Epoch. */
@Json(name = "buildStartTime")
val buildStartTime: kotlin.Long,
@@ -60,7 +61,7 @@
@Json(name = "gradleVersion")
val gradleVersion: kotlin.String,
- /* The Gradle Enterprise Gradle plugin version used. */
+ /* The Develocity Gradle plugin version used. */
@Json(name = "pluginVersion")
val pluginVersion: kotlin.String,
@@ -68,7 +69,7 @@
@Json(name = "requestedTasks")
val requestedTasks: kotlin.collections.List<kotlin.String>,
- /* True when the build failed, false otherwise. */
+ /* True when the build fails, false otherwise. */
@Json(name = "hasFailed")
val hasFailed: kotlin.Boolean,
@@ -85,19 +86,23 @@
val links: kotlin.collections.List<BuildAttributesLink>,
@Json(name = "gradleEnterpriseSettings")
+ @Deprecated(message = "This property is deprecated.")
val gradleEnterpriseSettings: GradleGradleEnterpriseSettings,
+ @Json(name = "develocitySettings")
+ val develocitySettings: GradleDevelocitySettings,
+
@Json(name = "buildOptions")
val buildOptions: GradleBuildOptions,
@Json(name = "environment")
val environment: BuildAttributesEnvironment,
- /* The root project name. May be `null` in case of very early build failure. */
+ /* The root project name. `null` in case of very early build failure. */
@Json(name = "rootProjectName")
val rootProjectName: kotlin.String? = null,
- /* Set only if the build failed: true when the build has at least one failure classified as \"Verification\", false otherwise. The Verification classification is meant for failures that are expected within a standard application development lifecycle. They typically represent a problem with the developer’s inputs to the build such as the source code. */
+ /* Set only if the build fails: true when the build has at least one failure classified as \"Verification\", false otherwise. The Verification classification is meant for failures that are expected within a standard application development lifecycle. They typically represent a problem with the developer’s inputs to the build such as the source code. */
@Json(name = "hasVerificationFailure")
val hasVerificationFailure: kotlin.Boolean? = null,
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt 2024-01-04 18:45:33.319408245 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt 2024-01-04 18:45:19.271306063 +0000
@@ -29,10 +29,13 @@
* @param effectiveWorkUnitExecutionTime Wall clock time spent executing work units (tasks and artifact transforms) in milliseconds. It is the time spent between the start of the first work unit in the execution phase and the end of the last work unit of the execution phase, removing any interval where no work unit is being executed.
* @param serialTaskExecutionTime Wall clock time of all task executions in milliseconds. It is the sum of all individual task durations.
* @param serialWorkUnitExecutionTime Wall clock time of all work unit executions (tasks and artifact transforms) in milliseconds. It is the sum of all individual work unit durations.
- * @param serializationFactor The ratio of `serialWorkUnitExecutionTime` over the `effectiveWorkUnitExecutionTime`. Quantifies the effect of work unit parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that work units were executed faster due to parallelization.
+ * @param serializationFactor The ratio of `serialWorkUnitExecutionTime` over the `effectiveWorkUnitExecutionTime`. Quantifies the effect of work unit parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that work units are executed faster due to parallelization.
* @param taskExecution A list of executed tasks with performance related information.
* @param avoidanceSavingsSummary
+ * @param taskAvoidanceSavingsSummary
+ * @param workUnitAvoidanceSavingsSummary
* @param taskFingerprintingSummary
+ * @param workUnitFingerprintingSummary
* @param buildCaches
*/
@@ -63,7 +66,7 @@
@Json(name = "serialWorkUnitExecutionTime")
val serialWorkUnitExecutionTime: kotlin.Long,
- /* The ratio of `serialWorkUnitExecutionTime` over the `effectiveWorkUnitExecutionTime`. Quantifies the effect of work unit parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that work units were executed faster due to parallelization. */
+ /* The ratio of `serialWorkUnitExecutionTime` over the `effectiveWorkUnitExecutionTime`. Quantifies the effect of work unit parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that work units are executed faster due to parallelization. */
@Json(name = "serializationFactor")
val serializationFactor: kotlin.Double,
@@ -72,11 +75,21 @@
val taskExecution: kotlin.collections.List<GradleBuildCachePerformanceTaskExecutionEntry>,
@Json(name = "avoidanceSavingsSummary")
+ @Deprecated(message = "This property is deprecated.")
val avoidanceSavingsSummary: GradleBuildCachePerformanceAvoidanceSavingsSummary,
+ @Json(name = "taskAvoidanceSavingsSummary")
+ val taskAvoidanceSavingsSummary: GradleBuildCachePerformanceTaskAvoidanceSavingsSummary,
+
+ @Json(name = "workUnitAvoidanceSavingsSummary")
+ val workUnitAvoidanceSavingsSummary: GradleBuildCachePerformanceWorkUnitAvoidanceSavingsSummary,
+
@Json(name = "taskFingerprintingSummary")
val taskFingerprintingSummary: GradleBuildCachePerformanceTaskFingerprintingSummary? = null,
+ @Json(name = "workUnitFingerprintingSummary")
+ val workUnitFingerprintingSummary: GradleBuildCachePerformanceWorkUnitFingerprintingSummary? = null,
+
@Json(name = "buildCaches")
val buildCaches: GradleBuildCachePerformanceBuildCaches? = null
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceAvoidanceSavingsSummary.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceAvoidanceSavingsSummary.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceAvoidanceSavingsSummary.kt 2024-01-04 18:45:32.447406644 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceAvoidanceSavingsSummary.kt 2024-01-04 18:45:18.287304140 +0000
@@ -20,15 +20,16 @@
import com.squareup.moshi.JsonClass
/**
- * A breakdown of avoidance savings.
+ * **This is deprecated, use `GradleBuildCachePerformanceTaskAvoidanceSavingsSummary` instead.** A breakdown of avoidance savings.
*
* @param total The estimated reduction in serial execution time of the tasks due to their outputs being reused in milliseconds.
- * @param ratio The ratio of the total avoidance savings against the potential serial execution time (which is the actual serial execution time plus the total avoidance savings). Quantifies the effect of avoidance savings in this build. The bigger the ratio is, the more time was saved when running the build.
+ * @param ratio The ratio of the total avoidance savings against the potential serial execution time (which is the actual serial execution time plus the total avoidance savings). Quantifies the effect of avoidance savings in this build. The bigger the ratio is, the more time is saved when running the build.
* @param upToDate The estimated reduction in serial execution time of the tasks due to build incrementalism in milliseconds.
* @param localBuildCache The estimated reduction in serial execution time of the tasks due to their outputs being reused from the local build cache in milliseconds.
* @param remoteBuildCache The estimated reduction in serial execution time of the tasks due to their outputs being reused from the remote build cache in millis...*[Comment body truncated]* |
gabrielfeo
added a commit
that referenced
this pull request
Nov 30, 2024
This reverts commit 2e357a8.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://docs.gradle.com/enterprise/api-manual/#release_history