/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/shield/Shield_EXPORTS.h> #include <aws/shield/ShieldRequest.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/shield/model/InclusionProtectionGroupFilters.h> #include <utility> namespace Aws { namespace Shield { namespace Model { /** */ class ListProtectionGroupsRequest : public ShieldRequest { public: AWS_SHIELD_API ListProtectionGroupsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListProtectionGroups"; } AWS_SHIELD_API Aws::String SerializePayload() const override; AWS_SHIELD_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline ListProtectionGroupsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline ListProtectionGroupsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** * <p>When you request a list of objects from Shield Advanced, if the response does * not include all of the remaining available objects, Shield Advanced includes a * <code>NextToken</code> value in the response. You can retrieve the next batch of * objects by requesting the list again and providing the token that was returned * by the prior call in your request. </p> <p>You can indicate the maximum number * of objects that you want Shield Advanced to return for a single call with the * <code>MaxResults</code> setting. Shield Advanced will not return more than * <code>MaxResults</code> objects, but may return fewer, even if more objects are * still available.</p> <p>Whenever more objects remain that Shield Advanced has * not yet returned to you, the response will include a <code>NextToken</code> * value.</p> <p>On your first call to a list operation, leave this setting * empty.</p> */ inline ListProtectionGroupsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** * <p>The greatest number of objects that you want Shield Advanced to return to the * list request. Shield Advanced might return fewer objects than you indicate in * this setting, even if more objects are available. If there are more objects * remaining, Shield Advanced will always also return a <code>NextToken</code> * value in the response.</p> <p>The default setting is 20.</p> */ inline int GetMaxResults() const{ return m_maxResults; } /** * <p>The greatest number of objects that you want Shield Advanced to return to the * list request. Shield Advanced might return fewer objects than you indicate in * this setting, even if more objects are available. If there are more objects * remaining, Shield Advanced will always also return a <code>NextToken</code> * value in the response.</p> <p>The default setting is 20.</p> */ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** * <p>The greatest number of objects that you want Shield Advanced to return to the * list request. Shield Advanced might return fewer objects than you indicate in * this setting, even if more objects are available. If there are more objects * remaining, Shield Advanced will always also return a <code>NextToken</code> * value in the response.</p> <p>The default setting is 20.</p> */ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** * <p>The greatest number of objects that you want Shield Advanced to return to the * list request. Shield Advanced might return fewer objects than you indicate in * this setting, even if more objects are available. If there are more objects * remaining, Shield Advanced will always also return a <code>NextToken</code> * value in the response.</p> <p>The default setting is 20.</p> */ inline ListProtectionGroupsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline const InclusionProtectionGroupFilters& GetInclusionFilters() const{ return m_inclusionFilters; } /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline bool InclusionFiltersHasBeenSet() const { return m_inclusionFiltersHasBeenSet; } /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline void SetInclusionFilters(const InclusionProtectionGroupFilters& value) { m_inclusionFiltersHasBeenSet = true; m_inclusionFilters = value; } /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline void SetInclusionFilters(InclusionProtectionGroupFilters&& value) { m_inclusionFiltersHasBeenSet = true; m_inclusionFilters = std::move(value); } /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline ListProtectionGroupsRequest& WithInclusionFilters(const InclusionProtectionGroupFilters& value) { SetInclusionFilters(value); return *this;} /** * <p>Narrows the set of protection groups that the call retrieves. You can * retrieve a single protection group by its name and you can retrieve all * protection groups that are configured with specific pattern or aggregation * settings. You can provide up to one criteria per filter type. Shield Advanced * returns the protection groups that exactly match all of the search criteria that * you provide.</p> */ inline ListProtectionGroupsRequest& WithInclusionFilters(InclusionProtectionGroupFilters&& value) { SetInclusionFilters(std::move(value)); return *this;} private: Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; InclusionProtectionGroupFilters m_inclusionFilters; bool m_inclusionFiltersHasBeenSet = false; }; } // namespace Model } // namespace Shield } // namespace Aws