1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/apigateway/APIGateway_EXPORTS.h> 8 #include <aws/apigateway/APIGatewayRequest.h> 9 #include <aws/core/utils/memory/stl/AWSString.h> 10 #include <utility> 11 12 namespace Aws 13 { 14 namespace APIGateway 15 { 16 namespace Model 17 { 18 19 /** 20 * <p>The GET request to get a usage plan key of a given key 21 * identifier.</p><p><h3>See Also:</h3> <a 22 * href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetUsagePlanKeyRequest">AWS 23 * API Reference</a></p> 24 */ 25 class AWS_APIGATEWAY_API GetUsagePlanKeyRequest : public APIGatewayRequest 26 { 27 public: 28 GetUsagePlanKeyRequest(); 29 30 // Service request name is the Operation name which will send this request out, 31 // each operation should has unique request name, so that we can get operation's name from this request. 32 // Note: this is not true for response, multiple operations may have the same response name, 33 // so we can not get operation's name from response. GetServiceRequestName()34 inline virtual const char* GetServiceRequestName() const override { return "GetUsagePlanKey"; } 35 36 Aws::String SerializePayload() const override; 37 38 39 /** 40 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 41 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 42 * plan customer.</p> 43 */ GetUsagePlanId()44 inline const Aws::String& GetUsagePlanId() const{ return m_usagePlanId; } 45 46 /** 47 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 48 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 49 * plan customer.</p> 50 */ UsagePlanIdHasBeenSet()51 inline bool UsagePlanIdHasBeenSet() const { return m_usagePlanIdHasBeenSet; } 52 53 /** 54 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 55 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 56 * plan customer.</p> 57 */ SetUsagePlanId(const Aws::String & value)58 inline void SetUsagePlanId(const Aws::String& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = value; } 59 60 /** 61 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 62 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 63 * plan customer.</p> 64 */ SetUsagePlanId(Aws::String && value)65 inline void SetUsagePlanId(Aws::String&& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = std::move(value); } 66 67 /** 68 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 69 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 70 * plan customer.</p> 71 */ SetUsagePlanId(const char * value)72 inline void SetUsagePlanId(const char* value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId.assign(value); } 73 74 /** 75 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 76 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 77 * plan customer.</p> 78 */ WithUsagePlanId(const Aws::String & value)79 inline GetUsagePlanKeyRequest& WithUsagePlanId(const Aws::String& value) { SetUsagePlanId(value); return *this;} 80 81 /** 82 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 83 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 84 * plan customer.</p> 85 */ WithUsagePlanId(Aws::String && value)86 inline GetUsagePlanKeyRequest& WithUsagePlanId(Aws::String&& value) { SetUsagePlanId(std::move(value)); return *this;} 87 88 /** 89 * <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage 90 * plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a 91 * plan customer.</p> 92 */ WithUsagePlanId(const char * value)93 inline GetUsagePlanKeyRequest& WithUsagePlanId(const char* value) { SetUsagePlanId(value); return *this;} 94 95 96 /** 97 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 98 * representing a plan customer.</p> 99 */ GetKeyId()100 inline const Aws::String& GetKeyId() const{ return m_keyId; } 101 102 /** 103 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 104 * representing a plan customer.</p> 105 */ KeyIdHasBeenSet()106 inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; } 107 108 /** 109 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 110 * representing a plan customer.</p> 111 */ SetKeyId(const Aws::String & value)112 inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; } 113 114 /** 115 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 116 * representing a plan customer.</p> 117 */ SetKeyId(Aws::String && value)118 inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); } 119 120 /** 121 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 122 * representing a plan customer.</p> 123 */ SetKeyId(const char * value)124 inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); } 125 126 /** 127 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 128 * representing a plan customer.</p> 129 */ WithKeyId(const Aws::String & value)130 inline GetUsagePlanKeyRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;} 131 132 /** 133 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 134 * representing a plan customer.</p> 135 */ WithKeyId(Aws::String && value)136 inline GetUsagePlanKeyRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;} 137 138 /** 139 * <p>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource 140 * representing a plan customer.</p> 141 */ WithKeyId(const char * value)142 inline GetUsagePlanKeyRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;} 143 144 private: 145 146 Aws::String m_usagePlanId; 147 bool m_usagePlanIdHasBeenSet; 148 149 Aws::String m_keyId; 150 bool m_keyIdHasBeenSet; 151 }; 152 153 } // namespace Model 154 } // namespace APIGateway 155 } // namespace Aws 156