-
Notifications
You must be signed in to change notification settings - Fork 0
Bump GE API spec version to 2023.2 #100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or 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
Contributor
Author
Generated API diffdiff -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 2023-10-10 15:43:03.536887324 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/BuildsApi.kt 2023-10-10 15:42:49.652721351 +0000
@@ -29,7 +29,7 @@
/**
* Get a list of builds with the common attributes of a Build Scan.
- * The contained attributes are build tool agnostic.
+ * 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.
* Responses:
* - 200: A list of builds with the common attributes of a Build Scan.
* - 400: The request cannot be fulfilled due to a problem.
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 2023-10-10 15:43:03.544887416 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformance.kt 2023-10-10 15:42:49.656721400 +0000
@@ -26,8 +26,10 @@
* @param id The Build Scan ID.
* @param buildTime Wall clock duration of the build in milliseconds.
* @param effectiveTaskExecutionTime Wall clock time spent executing tasks in milliseconds. It is the time spent between the start of the first task in the execution phase and the end of the last task of the execution phase, removing any interval where no task is being executed.
+ * @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 serializationFactor The ratio of `serialTaskExecutionTime` over the `effectiveTaskExecutionTime`. Quantifies the effect of task parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that tasks were executed faster due to parallelization.
+ * @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 taskExecution A list of executed tasks with performance related information.
* @param avoidanceSavingsSummary
* @param taskFingerprintingSummary
@@ -49,11 +51,19 @@
@Json(name = "effectiveTaskExecutionTime")
val effectiveTaskExecutionTime: kotlin.Long,
+ /* 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. */
+ @Json(name = "effectiveWorkUnitExecutionTime")
+ val effectiveWorkUnitExecutionTime: kotlin.Long,
+
/* Wall clock time of all task executions in milliseconds. It is the sum of all individual task durations. */
@Json(name = "serialTaskExecutionTime")
val serialTaskExecutionTime: kotlin.Long,
- /* The ratio of `serialTaskExecutionTime` over the `effectiveTaskExecutionTime`. Quantifies the effect of task parallelization. A value equal to `1` means that no parallelization occurred. A value greater than `1` means that tasks were executed faster due to parallelization. */
+ /* Wall clock time of all work unit executions (tasks and artifact transforms) in milliseconds. It is the sum of all individual work unit durations. */
+ @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. */
@Json(name = "serializationFactor")
val serializationFactor: kotlin.Double,
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt 2023-10-10 15:43:03.548887462 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt 2023-10-10 15:42:49.656721400 +0000
@@ -32,6 +32,7 @@
* @param nonCacheabilityReason The human-readable reason for a non-cacheable task. May be `null` when the task was cacheable or if the information was not available.
* @param skipReasonMessage The detailed reason why the task was skipped. May be `null` if the task was not skipped or Gradle versions <7.6 are used.
* @param cacheArtifactSize The number of bytes of the produced or consumed cache artifact. For a task execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a task execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the task is not cacheable, or if the attempt to store or load the artifact from cache did not succeed.
+ * @param cacheArtifactRejectedReason The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the task is not cacheable, or if the attempt to store the artifact did not succeed.
*/
@@ -75,7 +76,11 @@
/* The number of bytes of the produced or consumed cache artifact. For a task execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a task execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the task is not cacheable, or if the attempt to store or load the artifact from cache did not succeed. */
@Json(name = "cacheArtifactSize")
- val cacheArtifactSize: kotlin.Long? = null
+ val cacheArtifactSize: kotlin.Long? = null,
+
+ /* The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the task is not cacheable, or if the attempt to store the artifact did not succeed. */
+ @Json(name = "cacheArtifactRejectedReason")
+ val cacheArtifactRejectedReason: GradleBuildCachePerformanceTaskExecutionEntry.CacheArtifactRejectedReason? = null
) {
@@ -118,5 +123,14 @@
@Json(name = "task_output_caching_not_enabled") taskOutputCachingNotEnabled("task_output_caching_not_enabled"),
@Json(name = "unknown") unknown("unknown");
}
+ /**
+ * The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the task is not cacheable, or if the attempt to store the artifact did not succeed.
+ *
+ * Values: artifactSizeTooLarge
+ */
+ @JsonClass(generateAdapter = false)
+ enum class CacheArtifactRejectedReason(val value: kotlin.String) {
+ @Json(name = "artifact_size_too_large") artifactSizeTooLarge("artifact_size_too_large");
+ }
}
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt 2023-10-10 15:43:03.548887462 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt 2023-10-10 15:42:49.660721449 +0000
@@ -33,6 +33,7 @@
* @param nonCacheabilityCategory The category of the non-cacheability reason: * `build_cache_disabled_by_user` - The build cache was disabled by the user * `goal_execution_marked_non_cacheable` - The goal execution was marked as non-cacheable * `goal_not_supported` - The goal did not support build caching * `no_gradle_enterprise_server_configured` - No Gradle Enterprise server was configured * `non_clean_build` - The `clean` lifecycle was not executed * `not_entitled` - The Gradle Enterprise license entitlements did not allow Maven build caching * `offline_build` - The build was run in offline mode * `unknown` - Reason for disabled caching was not known * `unknown_entitlements` - The Gradle Enterprise license entitlements could not be checked May be `null` when the goal execution was cacheable or if the information was not available.
* @param nonCacheabilityReason The human-readable reason for a non-cacheable goal execution. May be `null` when the goal execution was cacheable or if the information was not available.
* @param cacheArtifactSize The number of bytes of the produced or consumed cache artifact. For a goal execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a goal execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the goal execution is not cacheable, or if the attempt to store or load the artifact from cache did not succeed.
+ * @param cacheArtifactRejectedReason The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the goal is not cacheable, or if the attempt to store the artifact did not succeed.
*/
@@ -80,7 +81,11 @@
/* The number of bytes of the produced or consumed cache artifact. For a goal execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a goal execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the goal execution is not cacheable, or if the attempt to store or load the artifact from cache did not succeed. */
@Json(name = "cacheArtifactSize")
- val cacheArtifactSize: kotlin.Long? = null
+ val cacheArtifactSize: kotlin.Long? = null,
+
+ /* The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the goal is not cacheable, or if the attempt to store the artifact did not succeed. */
+ @Json(name = "cacheArtifactRejectedReason")
+ val cacheArtifactRejectedReason: MavenBuildCachePerformanceGoalExecutionEntry.CacheArtifactRejectedReason? = null
) {
@@ -115,5 +120,14 @@
@Json(name = "unknown") unknown("unknown"),
@Json(name = "unknown_entitlements") unknownEntitlements("unknown_entitlements");
}
+ /**
+ * The reason why the cache artifact has been rejected: * `artifact_size_too_large` - The size of the artifact is larger than the remote build cache can accept. The value is `null` if the goal is not cacheable, or if the attempt to store the artifact did not succeed.
+ *
+ * Values: artifactSizeTooLarge
+ */
+ @JsonClass(generateAdapter = false)
+ enum class CacheArtifactRejectedReason(val value: kotlin.String) {
+ @Json(name = "artifact_size_too_large") artifactSizeTooLarge("artifact_size_too_large");
+ }
}
|
11d6d07 to
7b44262
Compare
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