/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Http { class URI; } //namespace Http namespace APIGateway { namespace Model { /** *

The GET request to get all the usage plan keys representing the API keys * added to a specified usage plan.

See Also:

AWS * API Reference

*/ class GetUsagePlanKeysRequest : public APIGatewayRequest { public: AWS_APIGATEWAY_API GetUsagePlanKeysRequest(); // 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 "GetUsagePlanKeys"; } AWS_APIGATEWAY_API Aws::String SerializePayload() const override; AWS_APIGATEWAY_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline const Aws::String& GetUsagePlanId() const{ return m_usagePlanId; } /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline bool UsagePlanIdHasBeenSet() const { return m_usagePlanIdHasBeenSet; } /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline void SetUsagePlanId(const Aws::String& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = value; } /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline void SetUsagePlanId(Aws::String&& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = std::move(value); } /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline void SetUsagePlanId(const char* value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId.assign(value); } /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline GetUsagePlanKeysRequest& WithUsagePlanId(const Aws::String& value) { SetUsagePlanId(value); return *this;} /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline GetUsagePlanKeysRequest& WithUsagePlanId(Aws::String&& value) { SetUsagePlanId(std::move(value)); return *this;} /** *

The Id of the UsagePlan resource representing the usage plan containing the * to-be-retrieved UsagePlanKey resource representing a plan customer.

*/ inline GetUsagePlanKeysRequest& WithUsagePlanId(const char* value) { SetUsagePlanId(value); return *this;} /** *

The current pagination position in the paged result set.

*/ inline const Aws::String& GetPosition() const{ return m_position; } /** *

The current pagination position in the paged result set.

*/ inline bool PositionHasBeenSet() const { return m_positionHasBeenSet; } /** *

The current pagination position in the paged result set.

*/ inline void SetPosition(const Aws::String& value) { m_positionHasBeenSet = true; m_position = value; } /** *

The current pagination position in the paged result set.

*/ inline void SetPosition(Aws::String&& value) { m_positionHasBeenSet = true; m_position = std::move(value); } /** *

The current pagination position in the paged result set.

*/ inline void SetPosition(const char* value) { m_positionHasBeenSet = true; m_position.assign(value); } /** *

The current pagination position in the paged result set.

*/ inline GetUsagePlanKeysRequest& WithPosition(const Aws::String& value) { SetPosition(value); return *this;} /** *

The current pagination position in the paged result set.

*/ inline GetUsagePlanKeysRequest& WithPosition(Aws::String&& value) { SetPosition(std::move(value)); return *this;} /** *

The current pagination position in the paged result set.

*/ inline GetUsagePlanKeysRequest& WithPosition(const char* value) { SetPosition(value); return *this;} /** *

The maximum number of returned results per page. The default value is 25 and * the maximum value is 500.

*/ inline int GetLimit() const{ return m_limit; } /** *

The maximum number of returned results per page. The default value is 25 and * the maximum value is 500.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

The maximum number of returned results per page. The default value is 25 and * the maximum value is 500.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

The maximum number of returned results per page. The default value is 25 and * the maximum value is 500.

*/ inline GetUsagePlanKeysRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline const Aws::String& GetNameQuery() const{ return m_nameQuery; } /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline bool NameQueryHasBeenSet() const { return m_nameQueryHasBeenSet; } /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline void SetNameQuery(const Aws::String& value) { m_nameQueryHasBeenSet = true; m_nameQuery = value; } /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline void SetNameQuery(Aws::String&& value) { m_nameQueryHasBeenSet = true; m_nameQuery = std::move(value); } /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline void SetNameQuery(const char* value) { m_nameQueryHasBeenSet = true; m_nameQuery.assign(value); } /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline GetUsagePlanKeysRequest& WithNameQuery(const Aws::String& value) { SetNameQuery(value); return *this;} /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline GetUsagePlanKeysRequest& WithNameQuery(Aws::String&& value) { SetNameQuery(std::move(value)); return *this;} /** *

A query parameter specifying the name of the to-be-returned usage plan * keys.

*/ inline GetUsagePlanKeysRequest& WithNameQuery(const char* value) { SetNameQuery(value); return *this;} private: Aws::String m_usagePlanId; bool m_usagePlanIdHasBeenSet = false; Aws::String m_position; bool m_positionHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_nameQuery; bool m_nameQueryHasBeenSet = false; }; } // namespace Model } // namespace APIGateway } // namespace Aws