This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-apigateway/include/aws/apigateway/model/DeleteUsagePlanKeyRequest.h

148 lines
5.5 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/apigateway/APIGateway_EXPORTS.h>
#include <aws/apigateway/APIGatewayRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace APIGateway
{
namespace Model
{
/**
* <p>The DELETE request to delete a usage plan key and remove the underlying API
* key from the associated usage plan.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/DeleteUsagePlanKeyRequest">AWS
* API Reference</a></p>
*/
class AWS_APIGATEWAY_API DeleteUsagePlanKeyRequest : public APIGatewayRequest
{
public:
DeleteUsagePlanKeyRequest();
// 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 "DeleteUsagePlanKey"; }
Aws::String SerializePayload() const override;
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline const Aws::String& GetUsagePlanId() const{ return m_usagePlanId; }
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline bool UsagePlanIdHasBeenSet() const { return m_usagePlanIdHasBeenSet; }
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline void SetUsagePlanId(const Aws::String& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = value; }
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline void SetUsagePlanId(Aws::String&& value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId = std::move(value); }
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline void SetUsagePlanId(const char* value) { m_usagePlanIdHasBeenSet = true; m_usagePlanId.assign(value); }
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline DeleteUsagePlanKeyRequest& WithUsagePlanId(const Aws::String& value) { SetUsagePlanId(value); return *this;}
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline DeleteUsagePlanKeyRequest& WithUsagePlanId(Aws::String&& value) { SetUsagePlanId(std::move(value)); return *this;}
/**
* <p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage
* plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a
* plan customer.</p>
*/
inline DeleteUsagePlanKeyRequest& WithUsagePlanId(const char* value) { SetUsagePlanId(value); return *this;}
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline const Aws::String& GetKeyId() const{ return m_keyId; }
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline DeleteUsagePlanKeyRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline DeleteUsagePlanKeyRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
/**
* <p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>
*/
inline DeleteUsagePlanKeyRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;}
private:
Aws::String m_usagePlanId;
bool m_usagePlanIdHasBeenSet;
Aws::String m_keyId;
bool m_keyIdHasBeenSet;
};
} // namespace Model
} // namespace APIGateway
} // namespace Aws