Class: Aws::CodeGuruReviewer::Types::RuleMetadata

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb

Overview

Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#long_description ⇒ String

A long description of the rule.

Returns:

  • (String) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1814

class RuleMetadata < Struct.new(
  :rule_id,
  :rule_name,
  :short_description,
  :long_description,
  :rule_tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

The ID of the rule.

Returns:

  • (String) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1814

class RuleMetadata < Struct.new(
  :rule_id,
  :rule_name,
  :short_description,
  :long_description,
  :rule_tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_name ⇒ String

The name of the rule.

Returns:

  • (String) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1814

class RuleMetadata < Struct.new(
  :rule_id,
  :rule_name,
  :short_description,
  :long_description,
  :rule_tags)
  SENSITIVE = []
  include Aws::Structure
end

#rule_tags ⇒ Array<String>

Tags that are associated with the rule.

Returns:

  • (Array<String>) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1814

class RuleMetadata < Struct.new(
  :rule_id,
  :rule_name,
  :short_description,
  :long_description,
  :rule_tags)
  SENSITIVE = []
  include Aws::Structure
end

#short_description ⇒ String

A short description of the rule.

Returns:

  • (String) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'gems/aws-sdk-codegurureviewer/lib/aws-sdk-codegurureviewer/types.rb', line 1814

class RuleMetadata < Struct.new(
  :rule_id,
  :rule_name,
  :short_description,
  :long_description,
  :rule_tags)
  SENSITIVE = []
  include Aws::Structure
end