Class: Aws::SecurityAgent::Types::CodeReviewJob

Inherits:

Struct

• Object
• Struct
• Aws::SecurityAgent::Types::CodeReviewJob

Defined in:

gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb

Overview

Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #code_remediation_strategy ⇒ String

  The code remediation strategy for the code review job.

• #code_review_id ⇒ String

  The unique identifier of the code review associated with the job.

• #code_review_job_id ⇒ String

  The unique identifier of the code review job.

• #created_at ⇒ Time

  The date and time the code review job was created, in UTC format.

• #documents ⇒ Array<Types::DocumentInfo>

  The list of documents providing context for the code review job.

• #error_information ⇒ Types::ErrorInformation

  Error information if the code review job encountered an error.

• #execution_context ⇒ Array<Types::ExecutionContext>

  The execution context messages for the code review job.

• #integrated_repositories ⇒ Array<Types::IntegratedRepository>

  The list of integrated repositories associated with the code review job.

• #log_config ⇒ Types::CloudWatchLog

  The CloudWatch Logs configuration for the code review job.

• #max_task_hours ⇒ Float

  The maximum number of billable task hours allowed for this code review job.

• #overview ⇒ String

  An overview of the code review job results.

• #report_destination ⇒ Types::ReportDestination

  The destination for publishing scan reports to an integrated document provider.

• #service_role ⇒ String

  The IAM service role used for the code review job.

• #source_code ⇒ Array<Types::SourceCodeRepository>

  The list of source code repositories analyzed during the code review job.

• #status ⇒ String

  The current status of the code review job.

• #steps ⇒ Array<Types::Step>

  The list of steps in the code review job execution.

• #title ⇒ String

  The title of the code review job.

• #updated_at ⇒ Time

  The date and time the code review job was last updated, in UTC format.

Instance Attribute Details

#code_remediation_strategy ⇒ String

The code remediation strategy for the code review job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#code_review_id ⇒ String

The unique identifier of the code review associated with the job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#code_review_job_id ⇒ String

The unique identifier of the code review job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time the code review job was created, in UTC format.

Returns:

• (Time)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#documents ⇒ Array<Types::DocumentInfo>

The list of documents providing context for the code review job.

Returns:

• (Array<Types::DocumentInfo>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#error_information ⇒ Types::ErrorInformation

Error information if the code review job encountered an error.

Returns:

• (Types::ErrorInformation)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#execution_context ⇒ Array<Types::ExecutionContext>

The execution context messages for the code review job.

Returns:

• (Array<Types::ExecutionContext>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#integrated_repositories ⇒ Array<Types::IntegratedRepository>

The list of integrated repositories associated with the code review job.

Returns:

• (Array<Types::IntegratedRepository>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#log_config ⇒ Types::CloudWatchLog

The CloudWatch Logs configuration for the code review job.

Returns:

• (Types::CloudWatchLog)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#max_task_hours ⇒ Float

The maximum number of billable task hours allowed for this code review job. If the cumulative task hours reach this limit, the job is gracefully stopped.

Returns:

• (Float)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#overview ⇒ String

An overview of the code review job results.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#report_destination ⇒ Types::ReportDestination

The destination for publishing scan reports to an integrated document provider.

Returns:

• (Types::ReportDestination)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The IAM service role used for the code review job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#source_code ⇒ Array<Types::SourceCodeRepository>

The list of source code repositories analyzed during the code review job.

Returns:

• (Array<Types::SourceCodeRepository>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the code review job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#steps ⇒ Array<Types::Step>

The list of steps in the code review job execution.

Returns:

• (Array<Types::Step>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the code review job.

Returns:

• (String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time the code review job was last updated, in UTC format.

Returns:

• (Time)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 2120

class CodeReviewJob < Struct.new(
  :code_review_job_id,
  :code_review_id,
  :title,
  :overview,
  :status,
  :documents,
  :source_code,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :error_information,
  :integrated_repositories,
  :code_remediation_strategy,
  :max_task_hours,
  :report_destination,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end