library/com.gabrielfeo.develocity.api/BuildsApi

BuildsApi

Functions

@GET(value = "api/builds/{id}/bazel-attributes")

abstract suspend fun getBazelAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): BazelAttributes

GET api/builds/{id}/bazel-attributes Get the attributes of a Bazel build. This model is Bazel specific and cannot be requested for another build tool. Responses:

getBazelCriticalPath

@GET(value = "api/builds/{id}/bazel-critical-path")

abstract suspend fun getBazelCriticalPath(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): BazelCriticalPath

GET api/builds/{id}/bazel-critical-path Get the critical path of a Bazel build. This model is Bazel specific and cannot be requested for another build tool. Responses:

getBuild

@GET(value = "api/builds/{id}")

abstract suspend fun getBuild(@Path(value = "id") id: String, @Query(value = "models") models: List<BuildModelName>? = null, @Query(value = "allModels") allModels: Boolean? = false, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): Build

GET api/builds/{id} Get the common attributes of a build. The contained attributes are build tool agnostic. Responses:

getBuilds

@GET(value = "api/builds")

abstract suspend fun getBuilds(@Query(value = "fromInstant") fromInstant: Long? = null, @Query(value = "fromBuild") fromBuild: String? = null, @Query(value = "reverse") reverse: Boolean? = null, @Query(value = "maxBuilds") maxBuilds: Int? = null, @Query(value = "maxWaitSecs") maxWaitSecs: Int? = null, @Query(value = "query") query: String? = null, @Query(value = "models") models: List<BuildModelName>? = null, @Query(value = "allModels") allModels: Boolean? = false, @Query(value = "since") since: Long? = null, @Query(value = "sinceBuild") sinceBuild: String? = null): List<Build>

GET api/builds 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:

getBuildsFlow

fun BuildsApi.getBuildsFlow(since: Long? = null, sinceBuild: String? = null, fromInstant: Long? = null, fromBuild: String? = null, query: String? = null, reverse: Boolean? = null, maxWaitSecs: Int? = null, buildsPerPage: Int = API_MAX_BUILDS, models: List<BuildModelName>? = null, allModels: Boolean? = false): Flow<Build>

Gets builds on demand from the API, in as many requests as necessary. It allows for queries of any size, as opposed to BuildsApi.getBuilds which is limited by the API itself to 1000.

getGradleArtifactTransformExecutions

@GET(value = "api/builds/{id}/gradle-artifact-transform-executions")

abstract suspend fun getGradleArtifactTransformExecutions(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleArtifactTransformExecutions

GET api/builds/{id}/gradle-artifact-transform-executions Get the artifact transform execution list of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleAttributes

@GET(value = "api/builds/{id}/gradle-attributes")

abstract suspend fun getGradleAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleAttributes

GET api/builds/{id}/gradle-attributes Get the attributes of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleAttributesFlow

fun BuildsApi.~~getGradleAttributesFlow~~(since: Long = 0, sinceBuild: String? = null, fromInstant: Long? = null, fromBuild: String? = null, query: String? = null, reverse: Boolean? = null, maxWaitSecs: Int? = null, scope: CoroutineScope = GlobalScope, models: List<BuildModelName>? = null): Flow<GradleAttributes>

Gets GradleAttributes of all builds from a given date. Queries BuildsApi.getBuilds first, the endpoint providing a timeline of builds, then maps each to BuildsApi.getGradleAttributes.

getGradleBuildCachePerformance

@GET(value = "api/builds/{id}/gradle-build-cache-performance")

abstract suspend fun getGradleBuildCachePerformance(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleBuildCachePerformance

GET api/builds/{id}/gradle-build-cache-performance Get the build cache performance of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleBuildProfileOverview

@GET(value = "api/builds/{id}/gradle-build-profile-overview")

abstract suspend fun getGradleBuildProfileOverview(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleBuildProfileOverview

GET api/builds/{id}/gradle-build-profile-overview Get the performance profile overview of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleConfigurationCache

@GET(value = "api/builds/{id}/gradle-configuration-cache")

abstract suspend fun getGradleConfigurationCache(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleConfigurationCache

GET api/builds/{id}/gradle-configuration-cache Get the configuration cache information for a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleDependencies

@GET(value = "api/builds/{id}/gradle-dependencies")

abstract suspend fun getGradleDependencies(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleDependencies

GET api/builds/{id}/gradle-dependencies Get the dependencies of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleDeprecations

@GET(value = "api/builds/{id}/gradle-deprecations")

abstract suspend fun getGradleDeprecations(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleDeprecations

GET api/builds/{id}/gradle-deprecations Get the Gradle Build Tool deprecations of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleNetworkActivity

@GET(value = "api/builds/{id}/gradle-network-activity")

abstract suspend fun getGradleNetworkActivity(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleNetworkActivity

GET api/builds/{id}/gradle-network-activity 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:

getGradlePlugins

@GET(value = "api/builds/{id}/gradle-plugins")

abstract suspend fun getGradlePlugins(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradlePlugins

GET api/builds/{id}/gradle-plugins Get the plugins of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleProjects

@GET(value = "api/builds/{id}/gradle-projects")

abstract suspend fun getGradleProjects(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): List<GradleProject>

GET api/builds/{id}/gradle-projects Get the projects of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleResourceUsage

@GET(value = "api/builds/{id}/gradle-resource-usage")

abstract suspend fun getGradleResourceUsage(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleResourceUsage

GET api/builds/{id}/gradle-resource-usage Get the resource usage of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getGradleTestPerformance

@GET(value = "api/builds/{id}/gradle-test-performance")

abstract suspend fun getGradleTestPerformance(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): GradleTestPerformance

GET api/builds/{id}/gradle-test-performance Get test performance-related metrics of a Gradle build. This model is Gradle specific and cannot be requested for another build tool. Responses:

getMavenAttributes

@GET(value = "api/builds/{id}/maven-attributes")

abstract suspend fun getMavenAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenAttributes

GET api/builds/{id}/maven-attributes Get the attributes of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenBuildCachePerformance

@GET(value = "api/builds/{id}/maven-build-cache-performance")

abstract suspend fun getMavenBuildCachePerformance(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenBuildCachePerformance

GET api/builds/{id}/maven-build-cache-performance Get the build cache performance of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenBuildProfileOverview

@GET(value = "api/builds/{id}/maven-build-profile-overview")

abstract suspend fun getMavenBuildProfileOverview(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenBuildProfileOverview

GET api/builds/{id}/maven-build-profile-overview Get the performance profile overview of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenDependencies

@GET(value = "api/builds/{id}/maven-dependencies")

abstract suspend fun getMavenDependencies(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenDependencies

GET api/builds/{id}/maven-dependencies Get the dependencies of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenDependencyResolution

@GET(value = "api/builds/{id}/maven-dependency-resolution")

abstract suspend fun getMavenDependencyResolution(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenDependencyResolution

GET api/builds/{id}/maven-dependency-resolution 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:

getMavenModules

@GET(value = "api/builds/{id}/maven-modules")

abstract suspend fun getMavenModules(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): List<MavenModule>

GET api/builds/{id}/maven-modules Get the modules of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenPlugins

@GET(value = "api/builds/{id}/maven-plugins")

abstract suspend fun getMavenPlugins(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenPlugins

GET api/builds/{id}/maven-plugins Get the plugins of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenResourceUsage

@GET(value = "api/builds/{id}/maven-resource-usage")

abstract suspend fun getMavenResourceUsage(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenResourceUsage

GET api/builds/{id}/maven-resource-usage Get the resource usage of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getMavenTestPerformance

@GET(value = "api/builds/{id}/maven-test-performance")

abstract suspend fun getMavenTestPerformance(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): MavenTestPerformance

GET api/builds/{id}/maven-test-performance Get test performance-related metrics of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses:

getNpmAttributes

@GET(value = "api/builds/{id}/npm-attributes")

abstract suspend fun getNpmAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): NpmAttributes

GET api/builds/{id}/npm-attributes Get the attributes of an npm build. This model is npm specific and cannot be requested for another build tool. Responses:

getPythonAttributes

@GET(value = "api/builds/{id}/python-attributes")

abstract suspend fun getPythonAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): PythonAttributes

GET api/builds/{id}/python-attributes Get the attributes of a Python build. This model is Python specific and cannot be requested for another build tool. Responses:

getSbtAttributes

@GET(value = "api/builds/{id}/sbt-attributes")

abstract suspend fun getSbtAttributes(@Path(value = "id") id: String, @Query(value = "availabilityWaitTimeoutSecs") availabilityWaitTimeoutSecs: Int? = null): SbtAttributes

GET api/builds/{id}/sbt-attributes Get the attributes of an sbt build. This model is sbt specific and cannot be requested for another build tool. Responses: