Class: Aws::CodeGuruReviewer::Types::CodeReview

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruReviewer::Types::CodeReview

Defined in:

(unknown)

Overview

Information about a code review. A code review belongs to the associated repository that contains the reviewed code.

Returned by:

• Aws::CodeGuruReviewer::Types::CreateCodeReviewResponse#code_review
• DescribeCodeReviewResponse#code_review

See Also:

• AWS API Documentation

Instance Attribute Summary

• #association_arn ⇒ String

  The Amazon Resource Name (ARN) of the [ RepositoryAssociation ][1] that contains the reviewed source code.

• #code_review_arn ⇒ String

  The Amazon Resource Name (ARN) of the [ CodeReview ][1] object.

• #created_time_stamp ⇒ Time

  The time, in milliseconds since the epoch, when the code review was created.

• #last_updated_time_stamp ⇒ Time

  The time, in milliseconds since the epoch, when the code review was last updated.

• #metrics ⇒ Types::Metrics

  The statistics from the code review.

• #name ⇒ String

  The name of the code review.

• #owner ⇒ String

  The owner of the repository.

• #provider_type ⇒ String

  The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

• #pull_request_id ⇒ String

  The pull request ID for the code review.

• #repository_name ⇒ String

  The name of the repository.

• #source_code_type ⇒ Types::SourceCodeType

  The type of the source code for the code review.

• #state ⇒ String

  The valid code review states are:.

• #state_reason ⇒ String

  The reason for the state of the code review.

• #type ⇒ String

  The type of code review.

Instance Attribute Details

#association_arn ⇒ String

The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the [ RepositoryAssociation ][1] that contains the reviewed source code.

#code_review_arn ⇒ String

The Amazon Resource Name (ARN) of the CodeReview object.

Returns:

• (String) —

  The Amazon Resource Name (ARN) of the [ CodeReview ][1] object.

#created_time_stamp ⇒ Time

The time, in milliseconds since the epoch, when the code review was created.

Returns:

• (Time) —

  The time, in milliseconds since the epoch, when the code review was created.

#last_updated_time_stamp ⇒ Time

The time, in milliseconds since the epoch, when the code review was last updated.

Returns:

• (Time) —

  The time, in milliseconds since the epoch, when the code review was last updated.

#metrics ⇒ Types::Metrics

The statistics from the code review.

Returns:

• (Types::Metrics) —

  The statistics from the code review.

#name ⇒ String

The name of the code review.

Returns:

• (String) —

  The name of the code review.

#owner ⇒ String

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

Returns:

• (String) —

  The owner of the repository.

#provider_type ⇒ String

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

Possible values:

• CodeCommit
• GitHub
• Bitbucket
• GitHubEnterpriseServer

Returns:

• (String) —

  The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

#pull_request_id ⇒ String

The pull request ID for the code review.

Returns:

• (String) —

  The pull request ID for the code review.

#repository_name ⇒ String

The name of the repository.

Returns:

• (String) —

  The name of the repository.

#source_code_type ⇒ Types::SourceCodeType

The type of the source code for the code review.

Returns:

• (Types::SourceCodeType) —

  The type of the source code for the code review.

#state ⇒ String

The valid code review states are:

• Completed: The code review is complete.

• Pending: The code review started and has not completed or failed.

• Failed: The code review failed.

• Deleting: The code review is being deleted.

  Possible values:

  • Completed
  • Pending
  • Failed
  • Deleting

Returns:

• (String) —

  The valid code review states are:.

#state_reason ⇒ String

The reason for the state of the code review.

Returns:

• (String) —

  The reason for the state of the code review.

#type ⇒ String

The type of code review.

Possible values:

• PullRequest
• RepositoryAnalysis

Returns:

• (String) —

  The type of code review.