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/CreateBasePathMappingRequest.h

268 lines
11 KiB
C
Raw Normal View History

/**
* 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>Requests API Gateway to create a new <a>BasePathMapping</a>
* resource.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/CreateBasePathMappingRequest">AWS
* API Reference</a></p>
*/
class AWS_APIGATEWAY_API CreateBasePathMappingRequest : public APIGatewayRequest
{
public:
CreateBasePathMappingRequest();
// 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 "CreateBasePathMapping"; }
Aws::String SerializePayload() const override;
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline const Aws::String& GetDomainName() const{ return m_domainName; }
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline bool DomainNameHasBeenSet() const { return m_domainNameHasBeenSet; }
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline void SetDomainName(const Aws::String& value) { m_domainNameHasBeenSet = true; m_domainName = value; }
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline void SetDomainName(Aws::String&& value) { m_domainNameHasBeenSet = true; m_domainName = std::move(value); }
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline void SetDomainName(const char* value) { m_domainNameHasBeenSet = true; m_domainName.assign(value); }
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline CreateBasePathMappingRequest& WithDomainName(const Aws::String& value) { SetDomainName(value); return *this;}
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline CreateBasePathMappingRequest& WithDomainName(Aws::String&& value) { SetDomainName(std::move(value)); return *this;}
/**
* <p>[Required] The domain name of the <a>BasePathMapping</a> resource to
* create.</p>
*/
inline CreateBasePathMappingRequest& WithDomainName(const char* value) { SetDomainName(value); return *this;}
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline const Aws::String& GetBasePath() const{ return m_basePath; }
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline bool BasePathHasBeenSet() const { return m_basePathHasBeenSet; }
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline void SetBasePath(const Aws::String& value) { m_basePathHasBeenSet = true; m_basePath = value; }
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline void SetBasePath(Aws::String&& value) { m_basePathHasBeenSet = true; m_basePath = std::move(value); }
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline void SetBasePath(const char* value) { m_basePathHasBeenSet = true; m_basePath.assign(value); }
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline CreateBasePathMappingRequest& WithBasePath(const Aws::String& value) { SetBasePath(value); return *this;}
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline CreateBasePathMappingRequest& WithBasePath(Aws::String&& value) { SetBasePath(std::move(value)); return *this;}
/**
* <p>The base path name that callers of the API must provide as part of the URL
* after the domain name. This value must be unique for all of the mappings across
* a single API. Specify '(none)' if you do not want callers to specify a base path
* name after the domain name.</p>
*/
inline CreateBasePathMappingRequest& WithBasePath(const char* value) { SetBasePath(value); return *this;}
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline const Aws::String& GetRestApiId() const{ return m_restApiId; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline bool RestApiIdHasBeenSet() const { return m_restApiIdHasBeenSet; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(const Aws::String& value) { m_restApiIdHasBeenSet = true; m_restApiId = value; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(Aws::String&& value) { m_restApiIdHasBeenSet = true; m_restApiId = std::move(value); }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(const char* value) { m_restApiIdHasBeenSet = true; m_restApiId.assign(value); }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateBasePathMappingRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;}
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateBasePathMappingRequest& WithRestApiId(Aws::String&& value) { SetRestApiId(std::move(value)); return *this;}
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateBasePathMappingRequest& WithRestApiId(const char* value) { SetRestApiId(value); return *this;}
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline const Aws::String& GetStage() const{ return m_stage; }
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline bool StageHasBeenSet() const { return m_stageHasBeenSet; }
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline void SetStage(const Aws::String& value) { m_stageHasBeenSet = true; m_stage = value; }
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline void SetStage(Aws::String&& value) { m_stageHasBeenSet = true; m_stage = std::move(value); }
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline void SetStage(const char* value) { m_stageHasBeenSet = true; m_stage.assign(value); }
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline CreateBasePathMappingRequest& WithStage(const Aws::String& value) { SetStage(value); return *this;}
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline CreateBasePathMappingRequest& WithStage(Aws::String&& value) { SetStage(std::move(value)); return *this;}
/**
* <p>The name of the API's stage that you want to use for this mapping. Specify
* '(none)' if you want callers to explicitly specify the stage name after any base
* path name.</p>
*/
inline CreateBasePathMappingRequest& WithStage(const char* value) { SetStage(value); return *this;}
private:
Aws::String m_domainName;
bool m_domainNameHasBeenSet;
Aws::String m_basePath;
bool m_basePathHasBeenSet;
Aws::String m_restApiId;
bool m_restApiIdHasBeenSet;
Aws::String m_stage;
bool m_stageHasBeenSet;
};
} // namespace Model
} // namespace APIGateway
} // namespace Aws