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 Http 15 { 16 class URI; 17 } //namespace Http 18 namespace APIGateway 19 { 20 namespace Model 21 { 22 23 /** 24 * <p>Requests API Gateway to get information about a <a>Deployments</a> 25 * collection.</p><p><h3>See Also:</h3> <a 26 * href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/GetDeploymentsRequest">AWS 27 * API Reference</a></p> 28 */ 29 class AWS_APIGATEWAY_API GetDeploymentsRequest : public APIGatewayRequest 30 { 31 public: 32 GetDeploymentsRequest(); 33 34 // Service request name is the Operation name which will send this request out, 35 // each operation should has unique request name, so that we can get operation's name from this request. 36 // Note: this is not true for response, multiple operations may have the same response name, 37 // so we can not get operation's name from response. GetServiceRequestName()38 inline virtual const char* GetServiceRequestName() const override { return "GetDeployments"; } 39 40 Aws::String SerializePayload() const override; 41 42 void AddQueryStringParameters(Aws::Http::URI& uri) const override; 43 44 45 /** 46 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 47 */ GetRestApiId()48 inline const Aws::String& GetRestApiId() const{ return m_restApiId; } 49 50 /** 51 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 52 */ RestApiIdHasBeenSet()53 inline bool RestApiIdHasBeenSet() const { return m_restApiIdHasBeenSet; } 54 55 /** 56 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 57 */ SetRestApiId(const Aws::String & value)58 inline void SetRestApiId(const Aws::String& value) { m_restApiIdHasBeenSet = true; m_restApiId = value; } 59 60 /** 61 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 62 */ SetRestApiId(Aws::String && value)63 inline void SetRestApiId(Aws::String&& value) { m_restApiIdHasBeenSet = true; m_restApiId = std::move(value); } 64 65 /** 66 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 67 */ SetRestApiId(const char * value)68 inline void SetRestApiId(const char* value) { m_restApiIdHasBeenSet = true; m_restApiId.assign(value); } 69 70 /** 71 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 72 */ WithRestApiId(const Aws::String & value)73 inline GetDeploymentsRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;} 74 75 /** 76 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 77 */ WithRestApiId(Aws::String && value)78 inline GetDeploymentsRequest& WithRestApiId(Aws::String&& value) { SetRestApiId(std::move(value)); return *this;} 79 80 /** 81 * <p>[Required] The string identifier of the associated <a>RestApi</a>.</p> 82 */ WithRestApiId(const char * value)83 inline GetDeploymentsRequest& WithRestApiId(const char* value) { SetRestApiId(value); return *this;} 84 85 86 /** 87 * <p>The current pagination position in the paged result set.</p> 88 */ GetPosition()89 inline const Aws::String& GetPosition() const{ return m_position; } 90 91 /** 92 * <p>The current pagination position in the paged result set.</p> 93 */ PositionHasBeenSet()94 inline bool PositionHasBeenSet() const { return m_positionHasBeenSet; } 95 96 /** 97 * <p>The current pagination position in the paged result set.</p> 98 */ SetPosition(const Aws::String & value)99 inline void SetPosition(const Aws::String& value) { m_positionHasBeenSet = true; m_position = value; } 100 101 /** 102 * <p>The current pagination position in the paged result set.</p> 103 */ SetPosition(Aws::String && value)104 inline void SetPosition(Aws::String&& value) { m_positionHasBeenSet = true; m_position = std::move(value); } 105 106 /** 107 * <p>The current pagination position in the paged result set.</p> 108 */ SetPosition(const char * value)109 inline void SetPosition(const char* value) { m_positionHasBeenSet = true; m_position.assign(value); } 110 111 /** 112 * <p>The current pagination position in the paged result set.</p> 113 */ WithPosition(const Aws::String & value)114 inline GetDeploymentsRequest& WithPosition(const Aws::String& value) { SetPosition(value); return *this;} 115 116 /** 117 * <p>The current pagination position in the paged result set.</p> 118 */ WithPosition(Aws::String && value)119 inline GetDeploymentsRequest& WithPosition(Aws::String&& value) { SetPosition(std::move(value)); return *this;} 120 121 /** 122 * <p>The current pagination position in the paged result set.</p> 123 */ WithPosition(const char * value)124 inline GetDeploymentsRequest& WithPosition(const char* value) { SetPosition(value); return *this;} 125 126 127 /** 128 * <p>The maximum number of returned results per page. The default value is 25 and 129 * the maximum value is 500.</p> 130 */ GetLimit()131 inline int GetLimit() const{ return m_limit; } 132 133 /** 134 * <p>The maximum number of returned results per page. The default value is 25 and 135 * the maximum value is 500.</p> 136 */ LimitHasBeenSet()137 inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } 138 139 /** 140 * <p>The maximum number of returned results per page. The default value is 25 and 141 * the maximum value is 500.</p> 142 */ SetLimit(int value)143 inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } 144 145 /** 146 * <p>The maximum number of returned results per page. The default value is 25 and 147 * the maximum value is 500.</p> 148 */ WithLimit(int value)149 inline GetDeploymentsRequest& WithLimit(int value) { SetLimit(value); return *this;} 150 151 private: 152 153 Aws::String m_restApiId; 154 bool m_restApiIdHasBeenSet; 155 156 Aws::String m_position; 157 bool m_positionHasBeenSet; 158 159 int m_limit; 160 bool m_limitHasBeenSet; 161 }; 162 163 } // namespace Model 164 } // namespace APIGateway 165 } // namespace Aws 166