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

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruReviewer::Types::SourceCodeType

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #branch_diff ⇒ Types::BranchDiffSourceCodeType

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

• #commit_diff ⇒ Types::CommitDiffSourceCodeType

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

• #repository_head ⇒ Types::RepositoryHeadSourceCodeType

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

• #request_metadata ⇒ Types::RequestMetadata

  Metadata that is associated with a code review.

• #s3_bucket_repository ⇒ Types::S3BucketRepository

  Information about an associated repository in an S3 bucket that includes its name and an S3RepositoryDetails object.

Instance Attribute Details

#branch_diff ⇒ Types::BranchDiffSourceCodeType

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

Returns:

• (Types::BranchDiffSourceCodeType)

# 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_diff ⇒ Types::CommitDiffSourceCodeType

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

Returns:

• (Types::CommitDiffSourceCodeType)

# 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_head ⇒ Types::RepositoryHeadSourceCodeType

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

Returns:

• (Types::RepositoryHeadSourceCodeType)

# 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_metadata ⇒ Types::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.

Returns:

• (Types::RequestMetadata)

# 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_repository ⇒ Types::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.

Returns:

• (Types::S3BucketRepository)

# 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