src.main.kotlin.com.gabrielfeo.develocity.api.BuildsApi.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of develocity-api-kotlin Show documentation
Show all versions of develocity-api-kotlin Show documentation
A library to use the Develocity API in Kotlin
The newest version!
package com.gabrielfeo.develocity.api
import com.gabrielfeo.develocity.api.internal.infrastructure.CollectionFormats.*
import retrofit2.http.*
import retrofit2.Response
import okhttp3.RequestBody
import com.squareup.moshi.Json
import com.gabrielfeo.develocity.api.model.ApiProblem
import com.gabrielfeo.develocity.api.model.BazelAttributes
import com.gabrielfeo.develocity.api.model.BazelCriticalPath
import com.gabrielfeo.develocity.api.model.Build
import com.gabrielfeo.develocity.api.model.BuildModelQuery
import com.gabrielfeo.develocity.api.model.BuildQuery
import com.gabrielfeo.develocity.api.model.BuildsQuery
import com.gabrielfeo.develocity.api.model.GradleArtifactTransformExecutions
import com.gabrielfeo.develocity.api.model.GradleAttributes
import com.gabrielfeo.develocity.api.model.GradleBuildCachePerformance
import com.gabrielfeo.develocity.api.model.GradleBuildProfileOverview
import com.gabrielfeo.develocity.api.model.GradleConfigurationCache
import com.gabrielfeo.develocity.api.model.GradleDeprecations
import com.gabrielfeo.develocity.api.model.GradleNetworkActivity
import com.gabrielfeo.develocity.api.model.GradlePlugins
import com.gabrielfeo.develocity.api.model.GradleProject
import com.gabrielfeo.develocity.api.model.GradleResourceUsage
import com.gabrielfeo.develocity.api.model.MavenAttributes
import com.gabrielfeo.develocity.api.model.MavenBuildCachePerformance
import com.gabrielfeo.develocity.api.model.MavenBuildProfileOverview
import com.gabrielfeo.develocity.api.model.MavenDependencyResolution
import com.gabrielfeo.develocity.api.model.MavenModule
import com.gabrielfeo.develocity.api.model.MavenPlugins
import com.gabrielfeo.develocity.api.model.MavenResourceUsage
import com.gabrielfeo.develocity.api.model.*
@JvmSuppressWildcards
interface BuildsApi {
/**
* Get the attributes of a Bazel build.
* This model is Bazel specific and cannot be requested for another build tool.
* Responses:
* - 200: The attributes of a Bazel build.
* - 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 [BazelAttributes]
*/
@GET("api/builds/{id}/bazel-attributes")
suspend fun getBazelAttributes(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): BazelAttributes
/**
* Get the critical path of a Bazel build.
* This model is Bazel specific and cannot be requested for another build tool.
* Responses:
* - 200: The critical path of a Bazel build.
* - 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 [BazelCriticalPath]
*/
@GET("api/builds/{id}/bazel-critical-path")
suspend fun getBazelCriticalPath(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): BazelCriticalPath
/**
* Get the common attributes of a build.
* The contained attributes are build tool agnostic.
* Responses:
* - 200: The common attributes of a build.
* - 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 models The list of build models to return in the response for each build. If not provided, no models are returned. (optional)
* @param allModels Whether to include all build models for the build. If set to `true`, the value of the `models` parameter is ignored. (optional, default to false)
* @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("models") models: kotlin.collections.List? = null, @Query("allModels") allModels: kotlin.Boolean? = false, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): Build
/**
* Get a list of builds with common attributes.
* 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 common attributes.
* - 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 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 Develocity advanced search query language See: https://gradle.com/help/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)
* @param allModels Whether to include all build models for each build. If set to `true`, the value of the `models` parameter is ignored. (optional, default to false)
* @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)
* @return [kotlin.collections.List]
*/
@GET("api/builds")
suspend fun getBuilds(@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? = null, @Query("allModels") allModels: kotlin.Boolean? = false, @Query("since") since: kotlin.Long? = null, @Query("sinceBuild") sinceBuild: kotlin.String? = null): kotlin.collections.List
/**
* Get the artifact transform execution list of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The artifact transform execution list of a Gradle build.
* - 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 [GradleArtifactTransformExecutions]
*/
@GET("api/builds/{id}/gradle-artifact-transform-executions")
suspend fun getGradleArtifactTransformExecutions(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleArtifactTransformExecutions
/**
* Get the attributes of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The attributes of a Gradle build.
* - 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 [GradleAttributes]
*/
@GET("api/builds/{id}/gradle-attributes")
suspend fun getGradleAttributes(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleAttributes
/**
* Get the build cache performance of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The build cache performance of a Gradle build.
* - 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 [GradleBuildCachePerformance]
*/
@GET("api/builds/{id}/gradle-build-cache-performance")
suspend fun getGradleBuildCachePerformance(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleBuildCachePerformance
/**
* Get the performance profile overview of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The performance profile overview of a Gradle build.
* - 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 [GradleBuildProfileOverview]
*/
@GET("api/builds/{id}/gradle-build-profile-overview")
suspend fun getGradleBuildProfileOverview(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleBuildProfileOverview
/**
* Get the configuration cache information for a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The configuration cache result of a Gradle build.
* - 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 [GradleConfigurationCache]
*/
@GET("api/builds/{id}/gradle-configuration-cache")
suspend fun getGradleConfigurationCache(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleConfigurationCache
/**
* Get the Gradle Build Tool deprecations of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The deprecation list of a Gradle build.
* - 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 [GradleDeprecations]
*/
@GET("api/builds/{id}/gradle-deprecations")
suspend fun getGradleDeprecations(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleDeprecations
/**
* Get the network activity of a Gradle build.
* 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.
* - 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 plugins of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The list of plugins in a Gradle build.
* - 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 [GradlePlugins]
*/
@GET("api/builds/{id}/gradle-plugins")
suspend fun getGradlePlugins(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradlePlugins
/**
* Get the projects of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The projects of a Gradle build.
* - 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 [kotlin.collections.List]
*/
@GET("api/builds/{id}/gradle-projects")
suspend fun getGradleProjects(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): kotlin.collections.List
/**
* Get the resource usage of a Gradle build.
* This model is Gradle specific and cannot be requested for another build tool.
* Responses:
* - 200: The resource usage of a Gradle build.
* - 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 [GradleResourceUsage]
*/
@GET("api/builds/{id}/gradle-resource-usage")
suspend fun getGradleResourceUsage(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): GradleResourceUsage
/**
* Get the attributes of a Maven build.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The attributes of a Maven build.
* - 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 [MavenAttributes]
*/
@GET("api/builds/{id}/maven-attributes")
suspend fun getMavenAttributes(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenAttributes
/**
* Get the build cache performance of a Maven build.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The build cache performance of a Maven build.
* - 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 [MavenBuildCachePerformance]
*/
@GET("api/builds/{id}/maven-build-cache-performance")
suspend fun getMavenBuildCachePerformance(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenBuildCachePerformance
/**
* Get the performance profile overview of a Maven build.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The performance profile overview of a Maven build.
* - 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 [MavenBuildProfileOverview]
*/
@GET("api/builds/{id}/maven-build-profile-overview")
suspend fun getMavenBuildProfileOverview(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenBuildProfileOverview
/**
* Get information about the dependency resolution of a Maven build.
* 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.
* - 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.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The modules of a Maven build.
* - 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 [kotlin.collections.List]
*/
@GET("api/builds/{id}/maven-modules")
suspend fun getMavenModules(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): kotlin.collections.List
/**
* Get the plugins of a Maven build.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The plugin list of a Maven build.
* - 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 [MavenPlugins]
*/
@GET("api/builds/{id}/maven-plugins")
suspend fun getMavenPlugins(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenPlugins
/**
* Get the resource usage of a Maven build.
* This model is Maven specific and cannot be requested for another build tool.
* Responses:
* - 200: The resource usage of a Maven build.
* - 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 [MavenResourceUsage]
*/
@GET("api/builds/{id}/maven-resource-usage")
suspend fun getMavenResourceUsage(@Path("id") id: kotlin.String, @Query("availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: kotlin.Int? = null): MavenResourceUsage
}