This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-waf/include/aws/waf/model/RuleSummary.h

198 lines
8.5 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/waf/WAF_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace WAF
{
namespace Model
{
/**
* <p>This is <b>AWS WAF Classic</b> documentation. For more information,
* see <a
* href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS
* WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS
* WAF</b>, use the AWS WAFV2 API and see the <a
* href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS
* WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of
* endpoints for regional and global use. </p> <p>Contains the identifier
* and the friendly name or description of the <code>Rule</code>.</p><p><h3>See
* Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/RuleSummary">AWS API
* Reference</a></p>
*/
class AWS_WAF_API RuleSummary
{
public:
RuleSummary();
RuleSummary(Aws::Utils::Json::JsonView jsonValue);
RuleSummary& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline const Aws::String& GetRuleId() const{ return m_ruleId; }
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline bool RuleIdHasBeenSet() const { return m_ruleIdHasBeenSet; }
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline void SetRuleId(const Aws::String& value) { m_ruleIdHasBeenSet = true; m_ruleId = value; }
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline void SetRuleId(Aws::String&& value) { m_ruleIdHasBeenSet = true; m_ruleId = std::move(value); }
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline void SetRuleId(const char* value) { m_ruleIdHasBeenSet = true; m_ruleId.assign(value); }
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline RuleSummary& WithRuleId(const Aws::String& value) { SetRuleId(value); return *this;}
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline RuleSummary& WithRuleId(Aws::String&& value) { SetRuleId(std::move(value)); return *this;}
/**
* <p>A unique identifier for a <code>Rule</code>. You use <code>RuleId</code> to
* get more information about a <code>Rule</code> (see <a>GetRule</a>), update a
* <code>Rule</code> (see <a>UpdateRule</a>), insert a <code>Rule</code> into a
* <code>WebACL</code> or delete one from a <code>WebACL</code> (see
* <a>UpdateWebACL</a>), or delete a <code>Rule</code> from AWS WAF (see
* <a>DeleteRule</a>).</p> <p> <code>RuleId</code> is returned by <a>CreateRule</a>
* and by <a>ListRules</a>.</p>
*/
inline RuleSummary& WithRuleId(const char* value) { SetRuleId(value); return *this;}
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline RuleSummary& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline RuleSummary& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>A friendly name or description of the <a>Rule</a>. You can't change the name
* of a <code>Rule</code> after you create it.</p>
*/
inline RuleSummary& WithName(const char* value) { SetName(value); return *this;}
private:
Aws::String m_ruleId;
bool m_ruleIdHasBeenSet;
Aws::String m_name;
bool m_nameHasBeenSet;
};
} // namespace Model
} // namespace WAF
} // namespace Aws