AWS SDK for C++  1.9.40
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::CreateBasePathMappingRequest Class Reference

#include <CreateBasePathMappingRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::CreateBasePathMappingRequest:

Public Member Functions

 CreateBasePathMappingRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDomainName () const
 
bool DomainNameHasBeenSet () const
 
void SetDomainName (const Aws::String &value)
 
void SetDomainName (Aws::String &&value)
 
void SetDomainName (const char *value)
 
CreateBasePathMappingRequestWithDomainName (const Aws::String &value)
 
CreateBasePathMappingRequestWithDomainName (Aws::String &&value)
 
CreateBasePathMappingRequestWithDomainName (const char *value)
 
const Aws::StringGetBasePath () const
 
bool BasePathHasBeenSet () const
 
void SetBasePath (const Aws::String &value)
 
void SetBasePath (Aws::String &&value)
 
void SetBasePath (const char *value)
 
CreateBasePathMappingRequestWithBasePath (const Aws::String &value)
 
CreateBasePathMappingRequestWithBasePath (Aws::String &&value)
 
CreateBasePathMappingRequestWithBasePath (const char *value)
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
CreateBasePathMappingRequestWithRestApiId (const Aws::String &value)
 
CreateBasePathMappingRequestWithRestApiId (Aws::String &&value)
 
CreateBasePathMappingRequestWithRestApiId (const char *value)
 
const Aws::StringGetStage () const
 
bool StageHasBeenSet () const
 
void SetStage (const Aws::String &value)
 
void SetStage (Aws::String &&value)
 
void SetStage (const char *value)
 
CreateBasePathMappingRequestWithStage (const Aws::String &value)
 
CreateBasePathMappingRequestWithStage (Aws::String &&value)
 
CreateBasePathMappingRequestWithStage (const char *value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Requests API Gateway to create a new BasePathMapping resource.

See Also:

AWS API Reference

Definition at line 25 of file CreateBasePathMappingRequest.h.

Constructor & Destructor Documentation

◆ CreateBasePathMappingRequest()

Aws::APIGateway::Model::CreateBasePathMappingRequest::CreateBasePathMappingRequest ( )

Member Function Documentation

◆ BasePathHasBeenSet()

bool Aws::APIGateway::Model::CreateBasePathMappingRequest::BasePathHasBeenSet ( ) const
inline

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.

Definition at line 102 of file CreateBasePathMappingRequest.h.

◆ DomainNameHasBeenSet()

bool Aws::APIGateway::Model::CreateBasePathMappingRequest::DomainNameHasBeenSet ( ) const
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 49 of file CreateBasePathMappingRequest.h.

◆ GetBasePath()

const Aws::String& Aws::APIGateway::Model::CreateBasePathMappingRequest::GetBasePath ( ) const
inline

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.

Definition at line 94 of file CreateBasePathMappingRequest.h.

◆ GetDomainName()

const Aws::String& Aws::APIGateway::Model::CreateBasePathMappingRequest::GetDomainName ( ) const
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 43 of file CreateBasePathMappingRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::CreateBasePathMappingRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 156 of file CreateBasePathMappingRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::CreateBasePathMappingRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateBasePathMappingRequest.h.

◆ GetStage()

const Aws::String& Aws::APIGateway::Model::CreateBasePathMappingRequest::GetStage ( ) const
inline

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.

Definition at line 199 of file CreateBasePathMappingRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::CreateBasePathMappingRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 161 of file CreateBasePathMappingRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::CreateBasePathMappingRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBasePath() [1/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetBasePath ( Aws::String &&  value)
inline

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.

Definition at line 118 of file CreateBasePathMappingRequest.h.

◆ SetBasePath() [2/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetBasePath ( const Aws::String value)
inline

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.

Definition at line 110 of file CreateBasePathMappingRequest.h.

◆ SetBasePath() [3/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetBasePath ( const char *  value)
inline

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.

Definition at line 126 of file CreateBasePathMappingRequest.h.

◆ SetDomainName() [1/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetDomainName ( Aws::String &&  value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 61 of file CreateBasePathMappingRequest.h.

◆ SetDomainName() [2/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetDomainName ( const Aws::String value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 55 of file CreateBasePathMappingRequest.h.

◆ SetDomainName() [3/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetDomainName ( const char *  value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 67 of file CreateBasePathMappingRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 171 of file CreateBasePathMappingRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 166 of file CreateBasePathMappingRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 176 of file CreateBasePathMappingRequest.h.

◆ SetStage() [1/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetStage ( Aws::String &&  value)
inline

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.

Definition at line 220 of file CreateBasePathMappingRequest.h.

◆ SetStage() [2/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetStage ( const Aws::String value)
inline

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.

Definition at line 213 of file CreateBasePathMappingRequest.h.

◆ SetStage() [3/3]

void Aws::APIGateway::Model::CreateBasePathMappingRequest::SetStage ( const char *  value)
inline

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.

Definition at line 227 of file CreateBasePathMappingRequest.h.

◆ StageHasBeenSet()

bool Aws::APIGateway::Model::CreateBasePathMappingRequest::StageHasBeenSet ( ) const
inline

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.

Definition at line 206 of file CreateBasePathMappingRequest.h.

◆ WithBasePath() [1/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithBasePath ( Aws::String &&  value)
inline

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.

Definition at line 142 of file CreateBasePathMappingRequest.h.

◆ WithBasePath() [2/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithBasePath ( const Aws::String value)
inline

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.

Definition at line 134 of file CreateBasePathMappingRequest.h.

◆ WithBasePath() [3/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithBasePath ( const char *  value)
inline

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.

Definition at line 150 of file CreateBasePathMappingRequest.h.

◆ WithDomainName() [1/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithDomainName ( Aws::String &&  value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 79 of file CreateBasePathMappingRequest.h.

◆ WithDomainName() [2/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithDomainName ( const Aws::String value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 73 of file CreateBasePathMappingRequest.h.

◆ WithDomainName() [3/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithDomainName ( const char *  value)
inline

[Required] The domain name of the BasePathMapping resource to create.

Definition at line 85 of file CreateBasePathMappingRequest.h.

◆ WithRestApiId() [1/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 186 of file CreateBasePathMappingRequest.h.

◆ WithRestApiId() [2/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 181 of file CreateBasePathMappingRequest.h.

◆ WithRestApiId() [3/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 191 of file CreateBasePathMappingRequest.h.

◆ WithStage() [1/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithStage ( Aws::String &&  value)
inline

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.

Definition at line 241 of file CreateBasePathMappingRequest.h.

◆ WithStage() [2/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithStage ( const Aws::String value)
inline

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.

Definition at line 234 of file CreateBasePathMappingRequest.h.

◆ WithStage() [3/3]

CreateBasePathMappingRequest& Aws::APIGateway::Model::CreateBasePathMappingRequest::WithStage ( const char *  value)
inline

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.

Definition at line 248 of file CreateBasePathMappingRequest.h.


The documentation for this class was generated from the following file: