Skip to content

Commit

Permalink
Add 2023.4.0-alpha01 javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 6, 2024
1 parent 490d07c commit cec176e
Show file tree
Hide file tree
Showing 746 changed files with 27,054 additions and 1,620 deletions.
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
2023.3.1 </div>
2023.4.0-alpha01 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":library:dokkaHtml/main">jvm</button>
Expand Down Expand Up @@ -124,7 +124,7 @@ <h2 class="">Packages</h2>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
2023.3.1 </div>
2023.4.0-alpha01 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":library:dokkaHtml/main">jvm</button>
Expand All @@ -66,10 +66,10 @@
<div class="cover ">
<h1 class="cover"><span><span>contains</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">operator </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../com.gabrielfeo.gradle.enterprise.api.model/-build-attributes-value/index.html">BuildAttributesValue</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="contains.html"><span class="token function">contains</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/gabrielfeo/gradle-enterprise-api-kotlin/blob/2023.3.1/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/extension/BuildAttributesValueExtensions.kt#L9">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">operator </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../com.gabrielfeo.gradle.enterprise.api.model/-build-attributes-value/index.html">BuildAttributesValue</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="contains.html"><span class="token function">contains</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">name<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/gabrielfeo/gradle-enterprise-api-kotlin/blob/2023.4.0-alpha01/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/extension/BuildAttributesValueExtensions.kt#L9">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
2023.3.1 </div>
2023.4.0-alpha01 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":library:dokkaHtml/main">jvm</button>
Expand All @@ -61,15 +61,15 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="library::com.gabrielfeo.gradle.enterprise.api.extension//getBuildsFlow/com.gabrielfeo.gradle.enterprise.api.BuildsApi#kotlin.Long#kotlin.String?#kotlin.Long?#kotlin.String?#kotlin.String?#kotlin.Boolean?#kotlin.Int?#kotlin.Int/PointingToDeclaration//-1951329584">
<div class="main-content" data-page-type="member" id="content" pageIds="library::com.gabrielfeo.gradle.enterprise.api.extension//getBuildsFlow/com.gabrielfeo.gradle.enterprise.api.BuildsApi#kotlin.Long?#kotlin.String?#kotlin.Long?#kotlin.String?#kotlin.String?#kotlin.Boolean?#kotlin.Int?#kotlin.Int/PointingToDeclaration//-1951329584">
<div class="breadcrumbs"><a href="../../index.html">library</a><span class="delimiter">/</span><a href="index.html">com.gabrielfeo.gradle.enterprise.api.extension</a><span class="delimiter">/</span><span class="current">getBuildsFlow</span></div>
<div class="cover ">
<h1 class="cover"><span>get</span><wbr></wbr><span>Builds</span><wbr></wbr><span><span>Flow</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/index.html">BuildsApi</a><span class="token punctuation">.</span><a href="get-builds-flow.html"><span class="token function">getBuildsFlow</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">since<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span><span class="token constant">0</span><span class="token punctuation">, </span></span><span class="parameter ">sinceBuild<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">fromInstant<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">fromBuild<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">query<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">reverse<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">maxWaitSecs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">buildsPerPage<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>API_MAX_BUILDS</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../com.gabrielfeo.gradle.enterprise.api.model/-build/index.html">Build</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/gabrielfeo/gradle-enterprise-api-kotlin/blob/2023.3.1/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/extension/BuildsApiExtensions.kt#L27">source</a>)</span></span></div><p class="paragraph">Gets builds on demand from the API, in as many requests as necessary. It allows for queries of any size, as opposed to <a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/get-builds.html">BuildsApi.getBuilds</a> which is limited by the API itself to 1000.</p><ul><li><p class="paragraph">Will request from the API until results end, collection stops or an error occurs.</p></li><li><p class="paragraph">Parameters same as <a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/get-builds.html">BuildsApi.getBuilds</a>.</p></li><li><p class="paragraph">Using <a href="get-builds-flow.html">query</a> is highly recommended for server-side filtering (equivalent to GE advanced query).</p></li><li><p class="paragraph"><code class="lang-kotlin">maxBuilds</code> is the only unsupported parameter, because this Flow will instead fetch continously. Use <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/index.html">Flow.take</a> to stop collecting at a specific count.</p></li></ul></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":library:dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/index.html">BuildsApi</a><span class="token punctuation">.</span><a href="get-builds-flow.html"><span class="token function">getBuildsFlow</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">since<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">sinceBuild<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">fromInstant<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">fromBuild<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">query<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">reverse<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">maxWaitSecs<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">buildsPerPage<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>API_MAX_BUILDS</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/-flow/index.html">Flow</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../com.gabrielfeo.gradle.enterprise.api.model/-build/index.html">Build</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/gabrielfeo/gradle-enterprise-api-kotlin/blob/2023.4.0-alpha01/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/extension/BuildsApiExtensions.kt#L26">source</a>)</span></span></div><p class="paragraph">Gets builds on demand from the API, in as many requests as necessary. It allows for queries of any size, as opposed to <a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/get-builds.html">BuildsApi.getBuilds</a> which is limited by the API itself to 1000.</p><ul><li><p class="paragraph">Will request from the API until results end, collection stops or an error occurs.</p></li><li><p class="paragraph">Parameters same as <a href="../com.gabrielfeo.gradle.enterprise.api/-builds-api/get-builds.html">BuildsApi.getBuilds</a>.</p></li><li><p class="paragraph">Using <a href="get-builds-flow.html">query</a> is highly recommended for server-side filtering (equivalent to GE advanced query).</p></li><li><p class="paragraph"><code class="lang-kotlin">maxBuilds</code> is the only unsupported parameter, because this Flow will instead fetch continously. Use <a href="https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/index.html">Flow.take</a> to stop collecting at a specific count.</p></li></ul></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
Expand Down
Loading

0 comments on commit cec176e

Please sign in to comment.