Skip to content

SourceCodeType

Source code in docs_src/capo_codeguru_reviewer/types/source_code_type.py
class SourceCodeType(TypedDict, closed=True):
    commit_diff: NotRequired[
        "capo_codeguru_reviewer.types.commit_diff_source_code_type.CommitDiffSourceCodeType"
    ]
    """<p>A <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a commit diff created by a pull request on an associated repository.</p>"""
    repository_head: NotRequired[
        "capo_codeguru_reviewer.types.repository_head_source_code_type.RepositoryHeadSourceCodeType"
    ]
    branch_diff: NotRequired[
        "capo_codeguru_reviewer.types.branch_diff_source_code_type.BranchDiffSourceCodeType"
    ]
    """<p>A type of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> that specifies a source branch name and a destination branch name in an associated repository.</p>"""
    s3_bucket_repository: NotRequired[
        "capo_codeguru_reviewer.types.s3_bucket_repository.S3BucketRepository"
    ]
    """<p>Information about an associated repository in an S3 bucket that includes its name and an <code>S3RepositoryDetails</code> object. The <code>S3RepositoryDetails</code> object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. <code>S3BucketRepository</code> is required in <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType">SourceCodeType</a> for <code>S3BucketRepository</code> based code reviews.</p>"""
    request_metadata: NotRequired[
        "capo_codeguru_reviewer.types.request_metadata.RequestMetadata"
    ]
    """<p>Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The <code>RequestMetadaa</code> field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request.</p>"""

branch_diff instance-attribute

branch_diff: NotRequired[BranchDiffSourceCodeType]

A type of SourceCodeType that specifies a source branch name and a destination branch name in an associated repository.

commit_diff instance-attribute

commit_diff: NotRequired[CommitDiffSourceCodeType]

A SourceCodeType that specifies a commit diff created by a pull request on an associated repository.

repository_head instance-attribute

repository_head: NotRequired[RepositoryHeadSourceCodeType]

request_metadata instance-attribute

request_metadata: NotRequired[RequestMetadata]

Metadata that is associated with a code review. This applies to any type of code review supported by CodeGuru Reviewer. The RequestMetadaa field captures any event metadata. For example, it might capture metadata associated with an event trigger, such as a push or a pull request.

s3_bucket_repository instance-attribute

s3_bucket_repository: NotRequired[S3BucketRepository]

Information about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object. The S3RepositoryDetails object includes the name of an S3 bucket, an S3 key for a source code .zip file, and an S3 key for a build artifacts .zip file. S3BucketRepository is required in SourceCodeType for S3BucketRepository based code reviews.