Skip to content

PullRequestTarget

Source code in docs_src/capo_codecommit/types/pull_request_target.py
class PullRequestTarget(TypedDict, closed=True):
    repository_name: NotRequired["capo_codecommit.types.repository_name.RepositoryName"]
    """<p>The name of the repository that contains the pull request source and destination branches.</p>"""
    source_reference: NotRequired["capo_codecommit.types.reference_name.ReferenceName"]
    """<p>The branch of the repository that contains the changes for the pull request. Also known as the source branch.</p>"""
    destination_reference: NotRequired[
        "capo_codecommit.types.reference_name.ReferenceName"
    ]
    """<p>The branch of the repository where the pull request changes are merged. Also known as the destination branch. </p>"""
    destination_commit: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.</p>"""
    source_commit: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.</p>"""
    merge_base: NotRequired["capo_codecommit.types.commit_id.CommitId"]
    """<p>The commit ID of the most recent commit that the source branch and the destination branch have in common.</p>"""
    merge_metadata: NotRequired["capo_codecommit.types.merge_metadata.MergeMetadata"]
    """<p>Returns metadata about the state of the merge, including whether the merge has been made.</p>"""

destination_commit instance-attribute

destination_commit: NotRequired[CommitId]

The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

destination_reference instance-attribute

destination_reference: NotRequired[ReferenceName]

The branch of the repository where the pull request changes are merged. Also known as the destination branch.

merge_base instance-attribute

merge_base: NotRequired[CommitId]

The commit ID of the most recent commit that the source branch and the destination branch have in common.

merge_metadata instance-attribute

merge_metadata: NotRequired[MergeMetadata]

Returns metadata about the state of the merge, including whether the merge has been made.

repository_name instance-attribute

repository_name: NotRequired[RepositoryName]

The name of the repository that contains the pull request source and destination branches.

source_commit instance-attribute

source_commit: NotRequired[CommitId]

The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.

source_reference instance-attribute

source_reference: NotRequired[ReferenceName]

The branch of the repository that contains the changes for the pull request. Also known as the source branch.