aws_sdk_codecommit/client/get_comments_for_compared_commit.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 [`GetCommentsForComparedCommit`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`repository_name(impl Into<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::set_repository_name):<br>required: **true**<br><p>The name of the repository where you want to compare commits.</p><br>
8 /// - [`before_commit_id(impl Into<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::before_commit_id) / [`set_before_commit_id(Option<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::set_before_commit_id):<br>required: **false**<br><p>To establish the directionality of the comparison, the full commit ID of the before commit.</p><br>
9 /// - [`after_commit_id(impl Into<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::after_commit_id) / [`set_after_commit_id(Option<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::set_after_commit_id):<br>required: **true**<br><p>To establish the directionality of the comparison, the full commit ID of the after commit.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::set_next_token):<br>required: **false**<br><p>An enumeration token that when provided in a request, returns the next batch of the results.</p><br>
11 /// - [`max_results(i32)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::set_max_results):<br>required: **false**<br><p>A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but you can configure up to 500.</p><br>
12 /// - On success, responds with [`GetCommentsForComparedCommitOutput`](crate::operation::get_comments_for_compared_commit::GetCommentsForComparedCommitOutput) with field(s):
13 /// - [`comments_for_compared_commit_data(Option<Vec::<CommentsForComparedCommit>>)`](crate::operation::get_comments_for_compared_commit::GetCommentsForComparedCommitOutput::comments_for_compared_commit_data): <p>A list of comment objects on the compared commit.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::get_comments_for_compared_commit::GetCommentsForComparedCommitOutput::next_token): <p>An enumeration token that can be used in a request to return the next batch of the results.</p>
15 /// - On failure, responds with [`SdkError<GetCommentsForComparedCommitError>`](crate::operation::get_comments_for_compared_commit::GetCommentsForComparedCommitError)
16 pub fn get_comments_for_compared_commit(
17 &self,
18 ) -> crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder {
19 crate::operation::get_comments_for_compared_commit::builders::GetCommentsForComparedCommitFluentBuilder::new(self.handle.clone())
20 }
21}