Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeGuruReviewer.Types.RuleMetadata

Description

Synopsis

Documentation

data RuleMetadata Source #

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: newRuleMetadata smart constructor.

Constructors

RuleMetadata'
Fields longDescription :: Maybe Text A long description of the rule. ruleTags :: Maybe (NonEmpty Text) Tags that are associated with the rule. ruleId :: Maybe Text The ID of the rule. ruleName :: Maybe Text The name of the rule. shortDescription :: Maybe Text A short description of the rule.

Instances

Instances details

Eq RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods (==) :: RuleMetadata -> RuleMetadata -> Bool # (/=) :: RuleMetadata -> RuleMetadata -> Bool #
Read RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods readsPrec :: Int -> ReadS RuleMetadata # readList :: ReadS [RuleMetadata] # readPrec :: ReadPrec RuleMetadata # readListPrec :: ReadPrec [RuleMetadata] #
Show RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods showsPrec :: Int -> RuleMetadata -> ShowS # show :: RuleMetadata -> String # showList :: [RuleMetadata] -> ShowS #
Generic RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Associated Types type Rep RuleMetadata :: Type -> Type # Methods from :: RuleMetadata -> Rep RuleMetadata x # to :: Rep RuleMetadata x -> RuleMetadata #
NFData RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods rnf :: RuleMetadata -> () #
Hashable RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods hashWithSalt :: Int -> RuleMetadata -> Int # hash :: RuleMetadata -> Int #
FromJSON RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata Methods parseJSON :: Value -> Parser RuleMetadata # parseJSONList :: Value -> Parser [RuleMetadata] #
type Rep RuleMetadata Source #
Instance details Defined in Amazonka.CodeGuruReviewer.Types.RuleMetadata type Rep RuleMetadata = D1 ('MetaData "RuleMetadata" "Amazonka.CodeGuruReviewer.Types.RuleMetadata" "libZSservicesZSamazonka-codeguru-reviewerZSamazonka-codeguru-reviewer" 'False) (C1 ('MetaCons "RuleMetadata'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "longDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ruleTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "ruleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ruleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "shortDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newRuleMetadata :: RuleMetadata Source #

Create a value of RuleMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:longDescription:RuleMetadata', ruleMetadata_longDescription - A long description of the rule.

$sel:ruleTags:RuleMetadata', ruleMetadata_ruleTags - Tags that are associated with the rule.

$sel:ruleId:RuleMetadata', ruleMetadata_ruleId - The ID of the rule.

$sel:ruleName:RuleMetadata', ruleMetadata_ruleName - The name of the rule.

$sel:shortDescription:RuleMetadata', ruleMetadata_shortDescription - A short description of the rule.

ruleMetadata_longDescription :: Lens' RuleMetadata (Maybe Text) Source #

A long description of the rule.

ruleMetadata_ruleTags :: Lens' RuleMetadata (Maybe (NonEmpty Text)) Source #

Tags that are associated with the rule.

ruleMetadata_ruleId :: Lens' RuleMetadata (Maybe Text) Source #

The ID of the rule.

ruleMetadata_ruleName :: Lens' RuleMetadata (Maybe Text) Source #

The name of the rule.

ruleMetadata_shortDescription :: Lens' RuleMetadata (Maybe Text) Source #

A short description of the rule.