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/neptune/Neptune_EXPORTS.h> 8 #include <aws/neptune/NeptuneRequest.h> 9 #include <aws/core/utils/memory/stl/AWSString.h> 10 #include <aws/core/utils/memory/stl/AWSVector.h> 11 #include <aws/neptune/model/Filter.h> 12 #include <utility> 13 14 namespace Aws 15 { 16 namespace Neptune 17 { 18 namespace Model 19 { 20 21 /** 22 */ 23 class AWS_NEPTUNE_API DescribeDBParametersRequest : public NeptuneRequest 24 { 25 public: 26 DescribeDBParametersRequest(); 27 28 // Service request name is the Operation name which will send this request out, 29 // each operation should has unique request name, so that we can get operation's name from this request. 30 // Note: this is not true for response, multiple operations may have the same response name, 31 // so we can not get operation's name from response. GetServiceRequestName()32 inline virtual const char* GetServiceRequestName() const override { return "DescribeDBParameters"; } 33 34 Aws::String SerializePayload() const override; 35 36 protected: 37 void DumpBodyToUrl(Aws::Http::URI& uri ) const override; 38 39 public: 40 41 /** 42 * <p>The name of a specific DB parameter group to return details for.</p> 43 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 44 * DBParameterGroup.</p> </li> </ul> 45 */ GetDBParameterGroupName()46 inline const Aws::String& GetDBParameterGroupName() const{ return m_dBParameterGroupName; } 47 48 /** 49 * <p>The name of a specific DB parameter group to return details for.</p> 50 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 51 * DBParameterGroup.</p> </li> </ul> 52 */ DBParameterGroupNameHasBeenSet()53 inline bool DBParameterGroupNameHasBeenSet() const { return m_dBParameterGroupNameHasBeenSet; } 54 55 /** 56 * <p>The name of a specific DB parameter group to return details for.</p> 57 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 58 * DBParameterGroup.</p> </li> </ul> 59 */ SetDBParameterGroupName(const Aws::String & value)60 inline void SetDBParameterGroupName(const Aws::String& value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName = value; } 61 62 /** 63 * <p>The name of a specific DB parameter group to return details for.</p> 64 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 65 * DBParameterGroup.</p> </li> </ul> 66 */ SetDBParameterGroupName(Aws::String && value)67 inline void SetDBParameterGroupName(Aws::String&& value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName = std::move(value); } 68 69 /** 70 * <p>The name of a specific DB parameter group to return details for.</p> 71 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 72 * DBParameterGroup.</p> </li> </ul> 73 */ SetDBParameterGroupName(const char * value)74 inline void SetDBParameterGroupName(const char* value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName.assign(value); } 75 76 /** 77 * <p>The name of a specific DB parameter group to return details for.</p> 78 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 79 * DBParameterGroup.</p> </li> </ul> 80 */ WithDBParameterGroupName(const Aws::String & value)81 inline DescribeDBParametersRequest& WithDBParameterGroupName(const Aws::String& value) { SetDBParameterGroupName(value); return *this;} 82 83 /** 84 * <p>The name of a specific DB parameter group to return details for.</p> 85 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 86 * DBParameterGroup.</p> </li> </ul> 87 */ WithDBParameterGroupName(Aws::String && value)88 inline DescribeDBParametersRequest& WithDBParameterGroupName(Aws::String&& value) { SetDBParameterGroupName(std::move(value)); return *this;} 89 90 /** 91 * <p>The name of a specific DB parameter group to return details for.</p> 92 * <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing 93 * DBParameterGroup.</p> </li> </ul> 94 */ WithDBParameterGroupName(const char * value)95 inline DescribeDBParametersRequest& WithDBParameterGroupName(const char* value) { SetDBParameterGroupName(value); return *this;} 96 97 98 /** 99 * <p>The parameter types to return.</p> <p>Default: All parameter types 100 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 101 */ GetSource()102 inline const Aws::String& GetSource() const{ return m_source; } 103 104 /** 105 * <p>The parameter types to return.</p> <p>Default: All parameter types 106 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 107 */ SourceHasBeenSet()108 inline bool SourceHasBeenSet() const { return m_sourceHasBeenSet; } 109 110 /** 111 * <p>The parameter types to return.</p> <p>Default: All parameter types 112 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 113 */ SetSource(const Aws::String & value)114 inline void SetSource(const Aws::String& value) { m_sourceHasBeenSet = true; m_source = value; } 115 116 /** 117 * <p>The parameter types to return.</p> <p>Default: All parameter types 118 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 119 */ SetSource(Aws::String && value)120 inline void SetSource(Aws::String&& value) { m_sourceHasBeenSet = true; m_source = std::move(value); } 121 122 /** 123 * <p>The parameter types to return.</p> <p>Default: All parameter types 124 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 125 */ SetSource(const char * value)126 inline void SetSource(const char* value) { m_sourceHasBeenSet = true; m_source.assign(value); } 127 128 /** 129 * <p>The parameter types to return.</p> <p>Default: All parameter types 130 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 131 */ WithSource(const Aws::String & value)132 inline DescribeDBParametersRequest& WithSource(const Aws::String& value) { SetSource(value); return *this;} 133 134 /** 135 * <p>The parameter types to return.</p> <p>Default: All parameter types 136 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 137 */ WithSource(Aws::String && value)138 inline DescribeDBParametersRequest& WithSource(Aws::String&& value) { SetSource(std::move(value)); return *this;} 139 140 /** 141 * <p>The parameter types to return.</p> <p>Default: All parameter types 142 * returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p> 143 */ WithSource(const char * value)144 inline DescribeDBParametersRequest& WithSource(const char* value) { SetSource(value); return *this;} 145 146 147 /** 148 * <p>This parameter is not currently supported.</p> 149 */ GetFilters()150 inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; } 151 152 /** 153 * <p>This parameter is not currently supported.</p> 154 */ FiltersHasBeenSet()155 inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } 156 157 /** 158 * <p>This parameter is not currently supported.</p> 159 */ SetFilters(const Aws::Vector<Filter> & value)160 inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; } 161 162 /** 163 * <p>This parameter is not currently supported.</p> 164 */ SetFilters(Aws::Vector<Filter> && value)165 inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } 166 167 /** 168 * <p>This parameter is not currently supported.</p> 169 */ WithFilters(const Aws::Vector<Filter> & value)170 inline DescribeDBParametersRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;} 171 172 /** 173 * <p>This parameter is not currently supported.</p> 174 */ WithFilters(Aws::Vector<Filter> && value)175 inline DescribeDBParametersRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;} 176 177 /** 178 * <p>This parameter is not currently supported.</p> 179 */ AddFilters(const Filter & value)180 inline DescribeDBParametersRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } 181 182 /** 183 * <p>This parameter is not currently supported.</p> 184 */ AddFilters(Filter && value)185 inline DescribeDBParametersRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } 186 187 188 /** 189 * <p>The maximum number of records to include in the response. If more records 190 * exist than the specified <code>MaxRecords</code> value, a pagination token 191 * called a marker is included in the response so that the remaining results can be 192 * retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> 193 */ GetMaxRecords()194 inline int GetMaxRecords() const{ return m_maxRecords; } 195 196 /** 197 * <p>The maximum number of records to include in the response. If more records 198 * exist than the specified <code>MaxRecords</code> value, a pagination token 199 * called a marker is included in the response so that the remaining results can be 200 * retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> 201 */ MaxRecordsHasBeenSet()202 inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } 203 204 /** 205 * <p>The maximum number of records to include in the response. If more records 206 * exist than the specified <code>MaxRecords</code> value, a pagination token 207 * called a marker is included in the response so that the remaining results can be 208 * retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> 209 */ SetMaxRecords(int value)210 inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } 211 212 /** 213 * <p>The maximum number of records to include in the response. If more records 214 * exist than the specified <code>MaxRecords</code> value, a pagination token 215 * called a marker is included in the response so that the remaining results can be 216 * retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p> 217 */ WithMaxRecords(int value)218 inline DescribeDBParametersRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} 219 220 221 /** 222 * <p>An optional pagination token provided by a previous 223 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 224 * response includes only records beyond the marker, up to the value specified by 225 * <code>MaxRecords</code>.</p> 226 */ GetMarker()227 inline const Aws::String& GetMarker() const{ return m_marker; } 228 229 /** 230 * <p>An optional pagination token provided by a previous 231 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 232 * response includes only records beyond the marker, up to the value specified by 233 * <code>MaxRecords</code>.</p> 234 */ MarkerHasBeenSet()235 inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } 236 237 /** 238 * <p>An optional pagination token provided by a previous 239 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 240 * response includes only records beyond the marker, up to the value specified by 241 * <code>MaxRecords</code>.</p> 242 */ SetMarker(const Aws::String & value)243 inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } 244 245 /** 246 * <p>An optional pagination token provided by a previous 247 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 248 * response includes only records beyond the marker, up to the value specified by 249 * <code>MaxRecords</code>.</p> 250 */ SetMarker(Aws::String && value)251 inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } 252 253 /** 254 * <p>An optional pagination token provided by a previous 255 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 256 * response includes only records beyond the marker, up to the value specified by 257 * <code>MaxRecords</code>.</p> 258 */ SetMarker(const char * value)259 inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } 260 261 /** 262 * <p>An optional pagination token provided by a previous 263 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 264 * response includes only records beyond the marker, up to the value specified by 265 * <code>MaxRecords</code>.</p> 266 */ WithMarker(const Aws::String & value)267 inline DescribeDBParametersRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} 268 269 /** 270 * <p>An optional pagination token provided by a previous 271 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 272 * response includes only records beyond the marker, up to the value specified by 273 * <code>MaxRecords</code>.</p> 274 */ WithMarker(Aws::String && value)275 inline DescribeDBParametersRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} 276 277 /** 278 * <p>An optional pagination token provided by a previous 279 * <code>DescribeDBParameters</code> request. If this parameter is specified, the 280 * response includes only records beyond the marker, up to the value specified by 281 * <code>MaxRecords</code>.</p> 282 */ WithMarker(const char * value)283 inline DescribeDBParametersRequest& WithMarker(const char* value) { SetMarker(value); return *this;} 284 285 private: 286 287 Aws::String m_dBParameterGroupName; 288 bool m_dBParameterGroupNameHasBeenSet; 289 290 Aws::String m_source; 291 bool m_sourceHasBeenSet; 292 293 Aws::Vector<Filter> m_filters; 294 bool m_filtersHasBeenSet; 295 296 int m_maxRecords; 297 bool m_maxRecordsHasBeenSet; 298 299 Aws::String m_marker; 300 bool m_markerHasBeenSet; 301 }; 302 303 } // namespace Model 304 } // namespace Neptune 305 } // namespace Aws 306