library/com.gabrielfeo.develocity.api/BuildsApi

BuildsApi

Functions

@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 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 = "since") since: Long? = null, @Query(value = "sinceBuild") sinceBuild: String? = null, @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): List<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:

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 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 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 the build cache performance 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 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 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:

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 the projects 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 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 the build cache performance 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 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 the modules of a Maven build. This model is Maven specific and cannot be requested for another build tool. Responses: