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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codegurureviewer/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_typesArray<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>)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_arnString

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)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_arnString

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

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_stateString

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)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_stampTime

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

Returns:

  • (Time)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_stampTime

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

Returns:

  • (Time)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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

#metricsTypes::Metrics

The statistics from the code review.

Returns:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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

#nameString

The name of the code review.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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

#ownerString

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)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_typeString

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

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_idString

The pull request ID for the code review.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_nameString

The name of the repository.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_typeTypes::SourceCodeType

The type of the source code for the code review.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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

#stateString

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)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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_reasonString

The reason for the state of the code review.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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

#typeString

The type of code review.

Returns:

  • (String)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 339

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