/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace CodeGuruReviewer { namespace Model { /** *

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:

AWS * API Reference

*/ class RuleMetadata { public: AWS_CODEGURUREVIEWER_API RuleMetadata(); AWS_CODEGURUREVIEWER_API RuleMetadata(Aws::Utils::Json::JsonView jsonValue); AWS_CODEGURUREVIEWER_API RuleMetadata& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_CODEGURUREVIEWER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ID of the rule.

*/ inline const Aws::String& GetRuleId() const{ return m_ruleId; } /** *

The ID of the rule.

*/ inline bool RuleIdHasBeenSet() const { return m_ruleIdHasBeenSet; } /** *

The ID of the rule.

*/ inline void SetRuleId(const Aws::String& value) { m_ruleIdHasBeenSet = true; m_ruleId = value; } /** *

The ID of the rule.

*/ inline void SetRuleId(Aws::String&& value) { m_ruleIdHasBeenSet = true; m_ruleId = std::move(value); } /** *

The ID of the rule.

*/ inline void SetRuleId(const char* value) { m_ruleIdHasBeenSet = true; m_ruleId.assign(value); } /** *

The ID of the rule.

*/ inline RuleMetadata& WithRuleId(const Aws::String& value) { SetRuleId(value); return *this;} /** *

The ID of the rule.

*/ inline RuleMetadata& WithRuleId(Aws::String&& value) { SetRuleId(std::move(value)); return *this;} /** *

The ID of the rule.

*/ inline RuleMetadata& WithRuleId(const char* value) { SetRuleId(value); return *this;} /** *

The name of the rule.

*/ inline const Aws::String& GetRuleName() const{ return m_ruleName; } /** *

The name of the rule.

*/ inline bool RuleNameHasBeenSet() const { return m_ruleNameHasBeenSet; } /** *

The name of the rule.

*/ inline void SetRuleName(const Aws::String& value) { m_ruleNameHasBeenSet = true; m_ruleName = value; } /** *

The name of the rule.

*/ inline void SetRuleName(Aws::String&& value) { m_ruleNameHasBeenSet = true; m_ruleName = std::move(value); } /** *

The name of the rule.

*/ inline void SetRuleName(const char* value) { m_ruleNameHasBeenSet = true; m_ruleName.assign(value); } /** *

The name of the rule.

*/ inline RuleMetadata& WithRuleName(const Aws::String& value) { SetRuleName(value); return *this;} /** *

The name of the rule.

*/ inline RuleMetadata& WithRuleName(Aws::String&& value) { SetRuleName(std::move(value)); return *this;} /** *

The name of the rule.

*/ inline RuleMetadata& WithRuleName(const char* value) { SetRuleName(value); return *this;} /** *

A short description of the rule.

*/ inline const Aws::String& GetShortDescription() const{ return m_shortDescription; } /** *

A short description of the rule.

*/ inline bool ShortDescriptionHasBeenSet() const { return m_shortDescriptionHasBeenSet; } /** *

A short description of the rule.

*/ inline void SetShortDescription(const Aws::String& value) { m_shortDescriptionHasBeenSet = true; m_shortDescription = value; } /** *

A short description of the rule.

*/ inline void SetShortDescription(Aws::String&& value) { m_shortDescriptionHasBeenSet = true; m_shortDescription = std::move(value); } /** *

A short description of the rule.

*/ inline void SetShortDescription(const char* value) { m_shortDescriptionHasBeenSet = true; m_shortDescription.assign(value); } /** *

A short description of the rule.

*/ inline RuleMetadata& WithShortDescription(const Aws::String& value) { SetShortDescription(value); return *this;} /** *

A short description of the rule.

*/ inline RuleMetadata& WithShortDescription(Aws::String&& value) { SetShortDescription(std::move(value)); return *this;} /** *

A short description of the rule.

*/ inline RuleMetadata& WithShortDescription(const char* value) { SetShortDescription(value); return *this;} /** *

A long description of the rule.

*/ inline const Aws::String& GetLongDescription() const{ return m_longDescription; } /** *

A long description of the rule.

*/ inline bool LongDescriptionHasBeenSet() const { return m_longDescriptionHasBeenSet; } /** *

A long description of the rule.

*/ inline void SetLongDescription(const Aws::String& value) { m_longDescriptionHasBeenSet = true; m_longDescription = value; } /** *

A long description of the rule.

*/ inline void SetLongDescription(Aws::String&& value) { m_longDescriptionHasBeenSet = true; m_longDescription = std::move(value); } /** *

A long description of the rule.

*/ inline void SetLongDescription(const char* value) { m_longDescriptionHasBeenSet = true; m_longDescription.assign(value); } /** *

A long description of the rule.

*/ inline RuleMetadata& WithLongDescription(const Aws::String& value) { SetLongDescription(value); return *this;} /** *

A long description of the rule.

*/ inline RuleMetadata& WithLongDescription(Aws::String&& value) { SetLongDescription(std::move(value)); return *this;} /** *

A long description of the rule.

*/ inline RuleMetadata& WithLongDescription(const char* value) { SetLongDescription(value); return *this;} /** *

Tags that are associated with the rule.

*/ inline const Aws::Vector& GetRuleTags() const{ return m_ruleTags; } /** *

Tags that are associated with the rule.

*/ inline bool RuleTagsHasBeenSet() const { return m_ruleTagsHasBeenSet; } /** *

Tags that are associated with the rule.

*/ inline void SetRuleTags(const Aws::Vector& value) { m_ruleTagsHasBeenSet = true; m_ruleTags = value; } /** *

Tags that are associated with the rule.

*/ inline void SetRuleTags(Aws::Vector&& value) { m_ruleTagsHasBeenSet = true; m_ruleTags = std::move(value); } /** *

Tags that are associated with the rule.

*/ inline RuleMetadata& WithRuleTags(const Aws::Vector& value) { SetRuleTags(value); return *this;} /** *

Tags that are associated with the rule.

*/ inline RuleMetadata& WithRuleTags(Aws::Vector&& value) { SetRuleTags(std::move(value)); return *this;} /** *

Tags that are associated with the rule.

*/ inline RuleMetadata& AddRuleTags(const Aws::String& value) { m_ruleTagsHasBeenSet = true; m_ruleTags.push_back(value); return *this; } /** *

Tags that are associated with the rule.

*/ inline RuleMetadata& AddRuleTags(Aws::String&& value) { m_ruleTagsHasBeenSet = true; m_ruleTags.push_back(std::move(value)); return *this; } /** *

Tags that are associated with the rule.

*/ inline RuleMetadata& AddRuleTags(const char* value) { m_ruleTagsHasBeenSet = true; m_ruleTags.push_back(value); return *this; } private: Aws::String m_ruleId; bool m_ruleIdHasBeenSet = false; Aws::String m_ruleName; bool m_ruleNameHasBeenSet = false; Aws::String m_shortDescription; bool m_shortDescriptionHasBeenSet = false; Aws::String m_longDescription; bool m_longDescriptionHasBeenSet = false; Aws::Vector m_ruleTags; bool m_ruleTagsHasBeenSet = false; }; } // namespace Model } // namespace CodeGuruReviewer } // namespace Aws