/aws-cpp-sdk-apigateway/include/aws/apigateway/model/GetUsagePlanKeyResult.h

https://github.com/aws/aws-sdk-cpp · C Header · 208 lines · 62 code · 41 blank · 105 comment · 0 complexity · 1c33f9759b6d61b8155a50ce955345d7 MD5 · raw file

  1. /**
  2. * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  3. * SPDX-License-Identifier: Apache-2.0.
  4. */
  5. #pragma once
  6. #include <aws/apigateway/APIGateway_EXPORTS.h>
  7. #include <aws/core/utils/memory/stl/AWSString.h>
  8. #include <utility>
  9. namespace Aws
  10. {
  11. template<typename RESULT_TYPE>
  12. class AmazonWebServiceResult;
  13. namespace Utils
  14. {
  15. namespace Json
  16. {
  17. class JsonValue;
  18. } // namespace Json
  19. } // namespace Utils
  20. namespace APIGateway
  21. {
  22. namespace Model
  23. {
  24. /**
  25. * <p>Represents a usage plan key to identify a plan customer.</p> <div
  26. * class="remarks"> <p>To associate an API stage with a selected API key in a usage
  27. * plan, you must create a UsagePlanKey resource to represent the selected
  28. * <a>ApiKey</a>.</p> </div>" <div class="seeAlso"> <a
  29. * href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html">Create
  30. * and Use Usage Plans</a> </div><p><h3>See Also:</h3> <a
  31. * href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/UsagePlanKey">AWS
  32. * API Reference</a></p>
  33. */
  34. class AWS_APIGATEWAY_API GetUsagePlanKeyResult
  35. {
  36. public:
  37. GetUsagePlanKeyResult();
  38. GetUsagePlanKeyResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
  39. GetUsagePlanKeyResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result);
  40. /**
  41. * <p>The Id of a usage plan key.</p>
  42. */
  43. inline const Aws::String& GetId() const{ return m_id; }
  44. /**
  45. * <p>The Id of a usage plan key.</p>
  46. */
  47. inline void SetId(const Aws::String& value) { m_id = value; }
  48. /**
  49. * <p>The Id of a usage plan key.</p>
  50. */
  51. inline void SetId(Aws::String&& value) { m_id = std::move(value); }
  52. /**
  53. * <p>The Id of a usage plan key.</p>
  54. */
  55. inline void SetId(const char* value) { m_id.assign(value); }
  56. /**
  57. * <p>The Id of a usage plan key.</p>
  58. */
  59. inline GetUsagePlanKeyResult& WithId(const Aws::String& value) { SetId(value); return *this;}
  60. /**
  61. * <p>The Id of a usage plan key.</p>
  62. */
  63. inline GetUsagePlanKeyResult& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;}
  64. /**
  65. * <p>The Id of a usage plan key.</p>
  66. */
  67. inline GetUsagePlanKeyResult& WithId(const char* value) { SetId(value); return *this;}
  68. /**
  69. * <p>The type of a usage plan key. Currently, the valid key type is
  70. * <code>API_KEY</code>.</p>
  71. */
  72. inline const Aws::String& GetType() const{ return m_type; }
  73. /**
  74. * <p>The type of a usage plan key. Currently, the valid key type is
  75. * <code>API_KEY</code>.</p>
  76. */
  77. inline void SetType(const Aws::String& value) { m_type = value; }
  78. /**
  79. * <p>The type of a usage plan key. Currently, the valid key type is
  80. * <code>API_KEY</code>.</p>
  81. */
  82. inline void SetType(Aws::String&& value) { m_type = std::move(value); }
  83. /**
  84. * <p>The type of a usage plan key. Currently, the valid key type is
  85. * <code>API_KEY</code>.</p>
  86. */
  87. inline void SetType(const char* value) { m_type.assign(value); }
  88. /**
  89. * <p>The type of a usage plan key. Currently, the valid key type is
  90. * <code>API_KEY</code>.</p>
  91. */
  92. inline GetUsagePlanKeyResult& WithType(const Aws::String& value) { SetType(value); return *this;}
  93. /**
  94. * <p>The type of a usage plan key. Currently, the valid key type is
  95. * <code>API_KEY</code>.</p>
  96. */
  97. inline GetUsagePlanKeyResult& WithType(Aws::String&& value) { SetType(std::move(value)); return *this;}
  98. /**
  99. * <p>The type of a usage plan key. Currently, the valid key type is
  100. * <code>API_KEY</code>.</p>
  101. */
  102. inline GetUsagePlanKeyResult& WithType(const char* value) { SetType(value); return *this;}
  103. /**
  104. * <p>The value of a usage plan key.</p>
  105. */
  106. inline const Aws::String& GetValue() const{ return m_value; }
  107. /**
  108. * <p>The value of a usage plan key.</p>
  109. */
  110. inline void SetValue(const Aws::String& value) { m_value = value; }
  111. /**
  112. * <p>The value of a usage plan key.</p>
  113. */
  114. inline void SetValue(Aws::String&& value) { m_value = std::move(value); }
  115. /**
  116. * <p>The value of a usage plan key.</p>
  117. */
  118. inline void SetValue(const char* value) { m_value.assign(value); }
  119. /**
  120. * <p>The value of a usage plan key.</p>
  121. */
  122. inline GetUsagePlanKeyResult& WithValue(const Aws::String& value) { SetValue(value); return *this;}
  123. /**
  124. * <p>The value of a usage plan key.</p>
  125. */
  126. inline GetUsagePlanKeyResult& WithValue(Aws::String&& value) { SetValue(std::move(value)); return *this;}
  127. /**
  128. * <p>The value of a usage plan key.</p>
  129. */
  130. inline GetUsagePlanKeyResult& WithValue(const char* value) { SetValue(value); return *this;}
  131. /**
  132. * <p>The name of a usage plan key.</p>
  133. */
  134. inline const Aws::String& GetName() const{ return m_name; }
  135. /**
  136. * <p>The name of a usage plan key.</p>
  137. */
  138. inline void SetName(const Aws::String& value) { m_name = value; }
  139. /**
  140. * <p>The name of a usage plan key.</p>
  141. */
  142. inline void SetName(Aws::String&& value) { m_name = std::move(value); }
  143. /**
  144. * <p>The name of a usage plan key.</p>
  145. */
  146. inline void SetName(const char* value) { m_name.assign(value); }
  147. /**
  148. * <p>The name of a usage plan key.</p>
  149. */
  150. inline GetUsagePlanKeyResult& WithName(const Aws::String& value) { SetName(value); return *this;}
  151. /**
  152. * <p>The name of a usage plan key.</p>
  153. */
  154. inline GetUsagePlanKeyResult& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
  155. /**
  156. * <p>The name of a usage plan key.</p>
  157. */
  158. inline GetUsagePlanKeyResult& WithName(const char* value) { SetName(value); return *this;}
  159. private:
  160. Aws::String m_id;
  161. Aws::String m_type;
  162. Aws::String m_value;
  163. Aws::String m_name;
  164. };
  165. } // namespace Model
  166. } // namespace APIGateway
  167. } // namespace Aws