Class: Aws::CodeGuruReviewer::Types::SourceCodeType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Note:

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

{
  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
  },
}

Specifies the source code that is analyzed in a code review.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#branch_diffTypes::BranchDiffSourceCodeType

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



2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 2327

class SourceCodeType < Struct.new(
  :commit_diff,
  :repository_head,
  :branch_diff,
  :s3_bucket_repository,
  :request_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#commit_diffTypes::CommitDiffSourceCodeType

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



2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 2327

class SourceCodeType < Struct.new(
  :commit_diff,
  :repository_head,
  :branch_diff,
  :s3_bucket_repository,
  :request_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#repository_headTypes::RepositoryHeadSourceCodeType

A SourceCodeType that specifies the tip of a branch in an associated repository.



2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 2327

class SourceCodeType < Struct.new(
  :commit_diff,
  :repository_head,
  :branch_diff,
  :s3_bucket_repository,
  :request_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#request_metadataTypes::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.



2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 2327

class SourceCodeType < Struct.new(
  :commit_diff,
  :repository_head,
  :branch_diff,
  :s3_bucket_repository,
  :request_metadata)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_repositoryTypes::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.



2327
2328
2329
2330
2331
2332
2333
2334
2335
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 2327

class SourceCodeType < Struct.new(
  :commit_diff,
  :repository_head,
  :branch_diff,
  :s3_bucket_repository,
  :request_metadata)
  SENSITIVE = []
  include Aws::Structure
end