Class: Aws::CodeGuruReviewer::Types::CodeReviewType

Inherits:

Struct

Object
Struct
Aws::CodeGuruReviewer::Types::CodeReviewType

show all

Defined in:: gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Note:

When making an API call, you may pass CodeReviewType data as a hash:

{
  repository_analysis: { # required
    repository_head: {
      branch_name: "BranchName", # required
    },
    source_code_type: {
      commit_diff: {
        source_commit: "CommitId",
        destination_commit: "CommitId",
        merge_base_commit: "CommitId",
      },
      repository_head: {
        branch_name: "BranchName", # required
      },
      branch_diff: {
        source_branch_name: "BranchName", # required
        destination_branch_name: "BranchName", # required
      },
      s3_bucket_repository: {
        name: "Name", # required
        details: {
          bucket_name: "S3BucketName",
          code_artifacts: {
            source_code_artifacts_object_key: "SourceCodeArtifactsObjectKey", # required
            build_artifacts_object_key: "BuildArtifactsObjectKey",
          },
        },
      },
      request_metadata: {
        request_id: "RequestId",
        requester: "Requester",
        event_info: {
          name: "EventName",
          state: "EventState",
        },
        vendor_name: "GitHub", # accepts GitHub, GitLab, NativeS3
      },
    },
  },
  analysis_types: ["Security"], # accepts Security, CodeQuality
}

The type of a code review. There are two code review types:

PullRequest - A code review that is automatically triggered by a pull request on an associated repository.
RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview .

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#analysis_types ⇒ Array<String>
They types of analysis performed during a repository analysis or a pull request review.
#repository_analysis ⇒ Types::RepositoryAnalysis
A code review that analyzes all code under a specified branch in an associated repository.

Instance Attribute Details

#analysis_types ⇒ `Array<String>`

They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

Returns:

(Array<String>)

# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 527

class CodeReviewType < Struct.new(
  :repository_analysis,
  :analysis_types)
  SENSITIVE = []
  include Aws::Structure
end

#repository_analysis ⇒ `Types::RepositoryAnalysis`

A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview .