Skip to content

CommentsForPullRequest

Source code in docs_src/capo_codecommit/types/comments_for_pull_request.py
class CommentsForPullRequest(TypedDict, closed=True):
    pull_request_id: NotRequired["capo_codecommit.types.pull_request_id.PullRequestId"]
    """<p>The system-generated ID of the pull request.</p>"""
    repository_name: NotRequired["capo_codecommit.types.repository_name.RepositoryName"]
    """<p>The name of the repository that contains the pull request.</p>"""
    before_commit_id: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.</p>"""
    after_commit_id: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The full commit ID of the commit that was the tip of the source branch at the time the comment was made. </p>"""
    before_blob_id: NotRequired["capo_codecommit.types.object_id.ObjectId"]
    """<p>The full blob ID of the file on which you want to comment on the destination commit.</p>"""
    after_blob_id: NotRequired["capo_codecommit.types.object_id.ObjectId"]
    """<p>The full blob ID of the file on which you want to comment on the source commit.</p>"""
    location: NotRequired["capo_codecommit.types.location.Location"]
    """<p>Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).</p>"""
    comments: NotRequired["capo_codecommit.types.comments.Comments"]
    """<p>An array of comment objects. Each comment object contains information about a comment on the pull request.</p>"""

after_blob_id instance-attribute

after_blob_id: NotRequired[ObjectId]

The full blob ID of the file on which you want to comment on the source commit.

after_commit_id instance-attribute

after_commit_id: NotRequired[CommitId]

The full commit ID of the commit that was the tip of the source branch at the time the comment was made.

before_blob_id instance-attribute

before_blob_id: NotRequired[ObjectId]

The full blob ID of the file on which you want to comment on the destination commit.

before_commit_id instance-attribute

before_commit_id: NotRequired[CommitId]

The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit is superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.

comments instance-attribute

comments: NotRequired[Comments]

An array of comment objects. Each comment object contains information about a comment on the pull request.

location instance-attribute

location: NotRequired[Location]

Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).

pull_request_id instance-attribute

pull_request_id: NotRequired[PullRequestId]

The system-generated ID of the pull request.

repository_name instance-attribute

repository_name: NotRequired[RepositoryName]

The name of the repository that contains the pull request.