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

#include <BasePathMapping.h>

Public Member Functions

 BasePathMapping ()
 
 BasePathMapping (Aws::Utils::Json::JsonView jsonValue)
 
BasePathMappingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBasePath () const
 
bool BasePathHasBeenSet () const
 
void SetBasePath (const Aws::String &value)
 
void SetBasePath (Aws::String &&value)
 
void SetBasePath (const char *value)
 
BasePathMappingWithBasePath (const Aws::String &value)
 
BasePathMappingWithBasePath (Aws::String &&value)
 
BasePathMappingWithBasePath (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)
 
BasePathMappingWithRestApiId (const Aws::String &value)
 
BasePathMappingWithRestApiId (Aws::String &&value)
 
BasePathMappingWithRestApiId (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)
 
BasePathMappingWithStage (const Aws::String &value)
 
BasePathMappingWithStage (Aws::String &&value)
 
BasePathMappingWithStage (const char *value)
 

Detailed Description

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.

See Also:

AWS API Reference

Definition at line 36 of file BasePathMapping.h.

Constructor & Destructor Documentation

◆ BasePathMapping() [1/2]

Aws::APIGateway::Model::BasePathMapping::BasePathMapping ( )

◆ BasePathMapping() [2/2]

Aws::APIGateway::Model::BasePathMapping::BasePathMapping ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BasePathHasBeenSet()

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

The base path name that callers of the API must provide as part of the URL after the domain name.

Definition at line 55 of file BasePathMapping.h.

◆ GetBasePath()

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

The base path name that callers of the API must provide as part of the URL after the domain name.

Definition at line 49 of file BasePathMapping.h.

◆ GetRestApiId()

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

The string identifier of the associated RestApi.

Definition at line 97 of file BasePathMapping.h.

◆ GetStage()

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

The name of the associated stage.

Definition at line 138 of file BasePathMapping.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::BasePathMapping::Jsonize ( ) const

◆ operator=()

BasePathMapping& Aws::APIGateway::Model::BasePathMapping::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RestApiIdHasBeenSet()

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

The string identifier of the associated RestApi.

Definition at line 102 of file BasePathMapping.h.

◆ SetBasePath() [1/3]

void Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 67 of file BasePathMapping.h.

◆ SetBasePath() [2/3]

void Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 61 of file BasePathMapping.h.

◆ SetBasePath() [3/3]

void Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 73 of file BasePathMapping.h.

◆ SetRestApiId() [1/3]

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

The string identifier of the associated RestApi.

Definition at line 112 of file BasePathMapping.h.

◆ SetRestApiId() [2/3]

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

The string identifier of the associated RestApi.

Definition at line 107 of file BasePathMapping.h.

◆ SetRestApiId() [3/3]

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

The string identifier of the associated RestApi.

Definition at line 117 of file BasePathMapping.h.

◆ SetStage() [1/3]

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

The name of the associated stage.

Definition at line 153 of file BasePathMapping.h.

◆ SetStage() [2/3]

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

The name of the associated stage.

Definition at line 148 of file BasePathMapping.h.

◆ SetStage() [3/3]

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

The name of the associated stage.

Definition at line 158 of file BasePathMapping.h.

◆ StageHasBeenSet()

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

The name of the associated stage.

Definition at line 143 of file BasePathMapping.h.

◆ WithBasePath() [1/3]

BasePathMapping& Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 85 of file BasePathMapping.h.

◆ WithBasePath() [2/3]

BasePathMapping& Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 79 of file BasePathMapping.h.

◆ WithBasePath() [3/3]

BasePathMapping& Aws::APIGateway::Model::BasePathMapping::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.

Definition at line 91 of file BasePathMapping.h.

◆ WithRestApiId() [1/3]

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

The string identifier of the associated RestApi.

Definition at line 127 of file BasePathMapping.h.

◆ WithRestApiId() [2/3]

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

The string identifier of the associated RestApi.

Definition at line 122 of file BasePathMapping.h.

◆ WithRestApiId() [3/3]

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

The string identifier of the associated RestApi.

Definition at line 132 of file BasePathMapping.h.

◆ WithStage() [1/3]

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

The name of the associated stage.

Definition at line 168 of file BasePathMapping.h.

◆ WithStage() [2/3]

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

The name of the associated stage.

Definition at line 163 of file BasePathMapping.h.

◆ WithStage() [3/3]

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

The name of the associated stage.

Definition at line 173 of file BasePathMapping.h.


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