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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-codegurureviewer/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_types ⇒ Array<String>

  The types of analysis performed during a repository analysis or a pull request review.

• #association_arn ⇒ String

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

• #code_review_arn ⇒ String

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

• #config_file_state ⇒ String

  The state of the ‘aws-codeguru-reviewer.yml` configuration file that allows the configuration of the CodeGuru Reviewer analysis.

• #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

#analysis_types ⇒ Array<String>

The 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 'lib/aws-sdk-codegurureviewer/types.rb', line 283

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#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].

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html [2]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#code_review_arn ⇒ String

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

[1]: docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#config_file_state ⇒ String

The state of the ‘aws-codeguru-reviewer.yml` configuration file that allows the configuration of the CodeGuru Reviewer analysis. The file either exists, doesn’t exist, or exists with errors at the root directory of your repository.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#created_time_stamp ⇒ Time

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

Returns:

• (Time)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_time_stamp ⇒ Time

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

Returns:

• (Time)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Types::Metrics

The statistics from the code review.

Returns:

• (Types::Metrics)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the code review.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services 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. For an S3 repository, it can be the username or Amazon Web Services account ID.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#provider_type ⇒ String

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

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#pull_request_id ⇒ String

The pull request ID for the code review.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#repository_name ⇒ String

The name of the repository.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#source_code_type ⇒ Types::SourceCodeType

The type of the source code for the code review.

Returns:

• (Types::SourceCodeType)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

The reason for the state of the code review.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of code review.

Returns:

• (String)

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

class CodeReview < Struct.new(
  :name,
  :code_review_arn,
  :repository_name,
  :owner,
  :provider_type,
  :state,
  :state_reason,
  :created_time_stamp,
  :last_updated_time_stamp,
  :type,
  :pull_request_id,
  :source_code_type,
  :association_arn,
  :metrics,
  :analysis_types,
  :config_file_state)
  SENSITIVE = []
  include Aws::Structure
end