aws_sdk_codecommit/client/post_comment_for_pull_request.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 [`PostCommentForPullRequest`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`pull_request_id(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::pull_request_id) / [`set_pull_request_id(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_pull_request_id):<br>required: **true**<br><p>The system-generated ID of the pull request. To get this ID, use <code>ListPullRequests</code>.</p><br>
7 /// - [`repository_name(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::repository_name) / [`set_repository_name(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_repository_name):<br>required: **true**<br><p>The name of the repository where you want to post a comment on a pull request.</p><br>
8 /// - [`before_commit_id(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::before_commit_id) / [`set_before_commit_id(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_before_commit_id):<br>required: **true**<br><p>The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.</p><br>
9 /// - [`after_commit_id(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::after_commit_id) / [`set_after_commit_id(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_after_commit_id):<br>required: **true**<br><p>The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.</p><br>
10 /// - [`location(Location)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::location) / [`set_location(Option<Location>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_location):<br>required: **false**<br><p>The location of the change where you want to post your comment. If no location is provided, the comment is posted as a general comment on the pull request difference between the before commit ID and the after commit ID.</p><br>
11 /// - [`content(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::content) / [`set_content(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_content):<br>required: **true**<br><p>The content of your comment on the change.</p><br>
12 /// - [`client_request_token(impl Into<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.</p><br>
13 /// - On success, responds with [`PostCommentForPullRequestOutput`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput) with field(s):
14 /// - [`repository_name(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::repository_name): <p>The name of the repository where you posted a comment on a pull request.</p>
15 /// - [`pull_request_id(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::pull_request_id): <p>The system-generated ID of the pull request.</p>
16 /// - [`before_commit_id(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::before_commit_id): <p>The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.</p>
17 /// - [`after_commit_id(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::after_commit_id): <p>The full commit ID of the commit in the destination branch where the pull request is merged.</p>
18 /// - [`before_blob_id(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::before_blob_id): <p>In the directionality of the pull request, the blob ID of the before blob.</p>
19 /// - [`after_blob_id(Option<String>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::after_blob_id): <p>In the directionality of the pull request, the blob ID of the after blob.</p>
20 /// - [`location(Option<Location>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::location): <p>The location of the change where you posted your comment.</p>
21 /// - [`comment(Option<Comment>)`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestOutput::comment): <p>The content of the comment you posted.</p>
22 /// - On failure, responds with [`SdkError<PostCommentForPullRequestError>`](crate::operation::post_comment_for_pull_request::PostCommentForPullRequestError)
23 pub fn post_comment_for_pull_request(&self) -> crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder {
24 crate::operation::post_comment_for_pull_request::builders::PostCommentForPullRequestFluentBuilder::new(self.handle.clone())
25 }
26}