aws_sdk_codebuild/client/list_build_batches_for_project.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ListBuildBatchesForProject`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`project_name(impl Into<String>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::project_name) / [`set_project_name(Option<String>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::set_project_name):<br>required: **false**<br><p>The name of the project.</p><br>
8 /// - [`filter(BuildBatchFilter)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::filter) / [`set_filter(Option<BuildBatchFilter>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::set_filter):<br>required: **false**<br><p>A <code>BuildBatchFilter</code> object that specifies the filters for the search.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
10 /// - [`sort_order(SortOrderType)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrderType>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::set_sort_order):<br>required: **false**<br><p>Specifies the sort order of the returned items. Valid values include:</p> <ul> <li> <p><code>ASCENDING</code>: List the batch build identifiers in ascending order by identifier.</p></li> <li> <p><code>DESCENDING</code>: List the batch build identifiers in descending order by identifier.</p></li> </ul><br>
11 /// - [`next_token(impl Into<String>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous call to <code>ListBuildBatchesForProject</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter.</p><br>
12 /// - On success, responds with [`ListBuildBatchesForProjectOutput`](crate::operation::list_build_batches_for_project::ListBuildBatchesForProjectOutput) with field(s):
13 /// - [`ids(Option<Vec::<String>>)`](crate::operation::list_build_batches_for_project::ListBuildBatchesForProjectOutput::ids): <p>An array of strings that contains the batch build identifiers.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::list_build_batches_for_project::ListBuildBatchesForProjectOutput::next_token): <p>If there are more items to return, this contains a token that is passed to a subsequent call to <code>ListBuildBatchesForProject</code> to retrieve the next set of items.</p>
15 /// - On failure, responds with [`SdkError<ListBuildBatchesForProjectError>`](crate::operation::list_build_batches_for_project::ListBuildBatchesForProjectError)
16 pub fn list_build_batches_for_project(
17 &self,
18 ) -> crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder {
19 crate::operation::list_build_batches_for_project::builders::ListBuildBatchesForProjectFluentBuilder::new(self.handle.clone())
20 }
21}