library/com.gabrielfeo.gradle.enterprise.api.model/BuildsQuery

BuildsQuery

data class BuildsQuery(@Json(name = "since") val since: Long? = null, @Json(name = "sinceBuild") val sinceBuild: String? = null, @Json(name = "fromInstant") val fromInstant: Long? = null, @Json(name = "fromBuild") val fromBuild: String? = null, @Json(name = "reverse") val reverse: Boolean? = null, @Json(name = "maxBuilds") val maxBuilds: Int? = null, @Json(name = "maxWaitSecs") val maxWaitSecs: Int? = null, @Json(name = "query") val query: String? = null, @Json(name = "models") val models: List<BuildModelName>? = null)

Parameters

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.

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.

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.

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.

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.

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.

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.

query

A query for filtering builds, written in the Develocity advanced search query language See: https://gradle.com/help/enterprise-advanced-search

models

The list of build models to return in the response for each build. If not provided, no models are returned.

Constructors

BuildsQuery

constructor(@Json(name = "since") since: Long? = null, @Json(name = "sinceBuild") sinceBuild: String? = null, @Json(name = "fromInstant") fromInstant: Long? = null, @Json(name = "fromBuild") fromBuild: String? = null, @Json(name = "reverse") reverse: Boolean? = null, @Json(name = "maxBuilds") maxBuilds: Int? = null, @Json(name = "maxWaitSecs") maxWaitSecs: Int? = null, @Json(name = "query") query: String? = null, @Json(name = "models") models: List<BuildModelName>? = null)