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

#include <GetStageResult.h>

Public Member Functions

 GetStageResult ()
 
 GetStageResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetStageResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetDeploymentId () const
 
void SetDeploymentId (const Aws::String &value)
 
void SetDeploymentId (Aws::String &&value)
 
void SetDeploymentId (const char *value)
 
GetStageResultWithDeploymentId (const Aws::String &value)
 
GetStageResultWithDeploymentId (Aws::String &&value)
 
GetStageResultWithDeploymentId (const char *value)
 
const Aws::StringGetClientCertificateId () const
 
void SetClientCertificateId (const Aws::String &value)
 
void SetClientCertificateId (Aws::String &&value)
 
void SetClientCertificateId (const char *value)
 
GetStageResultWithClientCertificateId (const Aws::String &value)
 
GetStageResultWithClientCertificateId (Aws::String &&value)
 
GetStageResultWithClientCertificateId (const char *value)
 
const Aws::StringGetStageName () const
 
void SetStageName (const Aws::String &value)
 
void SetStageName (Aws::String &&value)
 
void SetStageName (const char *value)
 
GetStageResultWithStageName (const Aws::String &value)
 
GetStageResultWithStageName (Aws::String &&value)
 
GetStageResultWithStageName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetStageResultWithDescription (const Aws::String &value)
 
GetStageResultWithDescription (Aws::String &&value)
 
GetStageResultWithDescription (const char *value)
 
bool GetCacheClusterEnabled () const
 
void SetCacheClusterEnabled (bool value)
 
GetStageResultWithCacheClusterEnabled (bool value)
 
const CacheClusterSizeGetCacheClusterSize () const
 
void SetCacheClusterSize (const CacheClusterSize &value)
 
void SetCacheClusterSize (CacheClusterSize &&value)
 
GetStageResultWithCacheClusterSize (const CacheClusterSize &value)
 
GetStageResultWithCacheClusterSize (CacheClusterSize &&value)
 
const CacheClusterStatusGetCacheClusterStatus () const
 
void SetCacheClusterStatus (const CacheClusterStatus &value)
 
void SetCacheClusterStatus (CacheClusterStatus &&value)
 
GetStageResultWithCacheClusterStatus (const CacheClusterStatus &value)
 
GetStageResultWithCacheClusterStatus (CacheClusterStatus &&value)
 
const Aws::Map< Aws::String, MethodSetting > & GetMethodSettings () const
 
void SetMethodSettings (const Aws::Map< Aws::String, MethodSetting > &value)
 
void SetMethodSettings (Aws::Map< Aws::String, MethodSetting > &&value)
 
GetStageResultWithMethodSettings (const Aws::Map< Aws::String, MethodSetting > &value)
 
GetStageResultWithMethodSettings (Aws::Map< Aws::String, MethodSetting > &&value)
 
GetStageResultAddMethodSettings (const Aws::String &key, const MethodSetting &value)
 
GetStageResultAddMethodSettings (Aws::String &&key, const MethodSetting &value)
 
GetStageResultAddMethodSettings (const Aws::String &key, MethodSetting &&value)
 
GetStageResultAddMethodSettings (Aws::String &&key, MethodSetting &&value)
 
GetStageResultAddMethodSettings (const char *key, MethodSetting &&value)
 
GetStageResultAddMethodSettings (const char *key, const MethodSetting &value)
 
const Aws::Map< Aws::String, Aws::String > & GetVariables () const
 
void SetVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
GetStageResultWithVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
GetStageResultWithVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
GetStageResultAddVariables (const Aws::String &key, const Aws::String &value)
 
GetStageResultAddVariables (Aws::String &&key, const Aws::String &value)
 
GetStageResultAddVariables (const Aws::String &key, Aws::String &&value)
 
GetStageResultAddVariables (Aws::String &&key, Aws::String &&value)
 
GetStageResultAddVariables (const char *key, Aws::String &&value)
 
GetStageResultAddVariables (Aws::String &&key, const char *value)
 
GetStageResultAddVariables (const char *key, const char *value)
 
const Aws::StringGetDocumentationVersion () const
 
void SetDocumentationVersion (const Aws::String &value)
 
void SetDocumentationVersion (Aws::String &&value)
 
void SetDocumentationVersion (const char *value)
 
GetStageResultWithDocumentationVersion (const Aws::String &value)
 
GetStageResultWithDocumentationVersion (Aws::String &&value)
 
GetStageResultWithDocumentationVersion (const char *value)
 
const AccessLogSettingsGetAccessLogSettings () const
 
void SetAccessLogSettings (const AccessLogSettings &value)
 
void SetAccessLogSettings (AccessLogSettings &&value)
 
GetStageResultWithAccessLogSettings (const AccessLogSettings &value)
 
GetStageResultWithAccessLogSettings (AccessLogSettings &&value)
 
const CanarySettingsGetCanarySettings () const
 
void SetCanarySettings (const CanarySettings &value)
 
void SetCanarySettings (CanarySettings &&value)
 
GetStageResultWithCanarySettings (const CanarySettings &value)
 
GetStageResultWithCanarySettings (CanarySettings &&value)
 
bool GetTracingEnabled () const
 
void SetTracingEnabled (bool value)
 
GetStageResultWithTracingEnabled (bool value)
 
const Aws::StringGetWebAclArn () const
 
void SetWebAclArn (const Aws::String &value)
 
void SetWebAclArn (Aws::String &&value)
 
void SetWebAclArn (const char *value)
 
GetStageResultWithWebAclArn (const Aws::String &value)
 
GetStageResultWithWebAclArn (Aws::String &&value)
 
GetStageResultWithWebAclArn (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetStageResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
GetStageResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetStageResultAddTags (const Aws::String &key, const Aws::String &value)
 
GetStageResultAddTags (Aws::String &&key, const Aws::String &value)
 
GetStageResultAddTags (const Aws::String &key, Aws::String &&value)
 
GetStageResultAddTags (Aws::String &&key, Aws::String &&value)
 
GetStageResultAddTags (const char *key, Aws::String &&value)
 
GetStageResultAddTags (Aws::String &&key, const char *value)
 
GetStageResultAddTags (const char *key, const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
GetStageResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
GetStageResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
GetStageResultWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
GetStageResultWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 

Detailed Description

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See Also:

AWS API Reference

Definition at line 42 of file GetStageResult.h.

Constructor & Destructor Documentation

◆ GetStageResult() [1/2]

Aws::APIGateway::Model::GetStageResult::GetStageResult ( )

◆ GetStageResult() [2/2]

Aws::APIGateway::Model::GetStageResult::GetStageResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddMethodSettings() [1/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( Aws::String &&  key,
const MethodSetting value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 337 of file GetStageResult.h.

◆ AddMethodSettings() [2/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( Aws::String &&  key,
MethodSetting &&  value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 353 of file GetStageResult.h.

◆ AddMethodSettings() [3/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( const Aws::String key,
const MethodSetting value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 329 of file GetStageResult.h.

◆ AddMethodSettings() [4/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( const Aws::String key,
MethodSetting &&  value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 345 of file GetStageResult.h.

◆ AddMethodSettings() [5/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( const char *  key,
const MethodSetting value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 369 of file GetStageResult.h.

◆ AddMethodSettings() [6/6]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddMethodSettings ( const char *  key,
MethodSetting &&  value 
)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 361 of file GetStageResult.h.

◆ AddTags() [1/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 652 of file GetStageResult.h.

◆ AddTags() [2/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 640 of file GetStageResult.h.

◆ AddTags() [3/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 664 of file GetStageResult.h.

◆ AddTags() [4/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 646 of file GetStageResult.h.

◆ AddTags() [5/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 634 of file GetStageResult.h.

◆ AddTags() [6/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 658 of file GetStageResult.h.

◆ AddTags() [7/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddTags ( const char *  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 670 of file GetStageResult.h.

◆ AddVariables() [1/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 433 of file GetStageResult.h.

◆ AddVariables() [2/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( Aws::String &&  key,
const Aws::String value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 419 of file GetStageResult.h.

◆ AddVariables() [3/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( Aws::String &&  key,
const char *  value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 447 of file GetStageResult.h.

◆ AddVariables() [4/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( const Aws::String key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 426 of file GetStageResult.h.

◆ AddVariables() [5/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( const Aws::String key,
const Aws::String value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 412 of file GetStageResult.h.

◆ AddVariables() [6/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( const char *  key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 440 of file GetStageResult.h.

◆ AddVariables() [7/7]

GetStageResult& Aws::APIGateway::Model::GetStageResult::AddVariables ( const char *  key,
const char *  value 
)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 454 of file GetStageResult.h.

◆ GetAccessLogSettings()

const AccessLogSettings& Aws::APIGateway::Model::GetStageResult::GetAccessLogSettings ( ) const
inline

Settings for logging access in this stage.

Definition at line 496 of file GetStageResult.h.

◆ GetCacheClusterEnabled()

bool Aws::APIGateway::Model::GetStageResult::GetCacheClusterEnabled ( ) const
inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 218 of file GetStageResult.h.

◆ GetCacheClusterSize()

const CacheClusterSize& Aws::APIGateway::Model::GetStageResult::GetCacheClusterSize ( ) const
inline

The size of the cache cluster for the stage, if enabled.

Definition at line 234 of file GetStageResult.h.

◆ GetCacheClusterStatus()

const CacheClusterStatus& Aws::APIGateway::Model::GetStageResult::GetCacheClusterStatus ( ) const
inline

The status of the cache cluster for the stage, if enabled.

Definition at line 260 of file GetStageResult.h.

◆ GetCanarySettings()

const CanarySettings& Aws::APIGateway::Model::GetStageResult::GetCanarySettings ( ) const
inline

Settings for the canary deployment in this stage.

Definition at line 522 of file GetStageResult.h.

◆ GetClientCertificateId()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetClientCertificateId ( ) const
inline

The identifier of a client certificate for an API stage.

Definition at line 89 of file GetStageResult.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::GetStageResult::GetCreatedDate ( ) const
inline

The timestamp when the stage was created.

Definition at line 676 of file GetStageResult.h.

◆ GetDeploymentId()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetDeploymentId ( ) const
inline

The identifier of the Deployment that the stage points to.

Definition at line 53 of file GetStageResult.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetDescription ( ) const
inline

The stage's description.

Definition at line 182 of file GetStageResult.h.

◆ GetDocumentationVersion()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetDocumentationVersion ( ) const
inline

The version of the associated API documentation.

Definition at line 460 of file GetStageResult.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::GetStageResult::GetLastUpdatedDate ( ) const
inline

The timestamp when the stage last updated.

Definition at line 702 of file GetStageResult.h.

◆ GetMethodSettings()

const Aws::Map<Aws::String, MethodSetting>& Aws::APIGateway::Model::GetStageResult::GetMethodSettings ( ) const
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 289 of file GetStageResult.h.

◆ GetStageName()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetStageName ( ) const
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 128 of file GetStageResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetStageResult::GetTags ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 604 of file GetStageResult.h.

◆ GetTracingEnabled()

bool Aws::APIGateway::Model::GetStageResult::GetTracingEnabled ( ) const
inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 549 of file GetStageResult.h.

◆ GetVariables()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetStageResult::GetVariables ( ) const
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 377 of file GetStageResult.h.

◆ GetWebAclArn()

const Aws::String& Aws::APIGateway::Model::GetStageResult::GetWebAclArn ( ) const
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 567 of file GetStageResult.h.

◆ operator=()

GetStageResult& Aws::APIGateway::Model::GetStageResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAccessLogSettings() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetAccessLogSettings ( AccessLogSettings &&  value)
inline

Settings for logging access in this stage.

Definition at line 506 of file GetStageResult.h.

◆ SetAccessLogSettings() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetAccessLogSettings ( const AccessLogSettings value)
inline

Settings for logging access in this stage.

Definition at line 501 of file GetStageResult.h.

◆ SetCacheClusterEnabled()

void Aws::APIGateway::Model::GetStageResult::SetCacheClusterEnabled ( bool  value)
inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 223 of file GetStageResult.h.

◆ SetCacheClusterSize() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetCacheClusterSize ( CacheClusterSize &&  value)
inline

The size of the cache cluster for the stage, if enabled.

Definition at line 244 of file GetStageResult.h.

◆ SetCacheClusterSize() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetCacheClusterSize ( const CacheClusterSize value)
inline

The size of the cache cluster for the stage, if enabled.

Definition at line 239 of file GetStageResult.h.

◆ SetCacheClusterStatus() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetCacheClusterStatus ( CacheClusterStatus &&  value)
inline

The status of the cache cluster for the stage, if enabled.

Definition at line 270 of file GetStageResult.h.

◆ SetCacheClusterStatus() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetCacheClusterStatus ( const CacheClusterStatus value)
inline

The status of the cache cluster for the stage, if enabled.

Definition at line 265 of file GetStageResult.h.

◆ SetCanarySettings() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetCanarySettings ( CanarySettings &&  value)
inline

Settings for the canary deployment in this stage.

Definition at line 532 of file GetStageResult.h.

◆ SetCanarySettings() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetCanarySettings ( const CanarySettings value)
inline

Settings for the canary deployment in this stage.

Definition at line 527 of file GetStageResult.h.

◆ SetClientCertificateId() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetClientCertificateId ( Aws::String &&  value)
inline

The identifier of a client certificate for an API stage.

Definition at line 99 of file GetStageResult.h.

◆ SetClientCertificateId() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetClientCertificateId ( const Aws::String value)
inline

The identifier of a client certificate for an API stage.

Definition at line 94 of file GetStageResult.h.

◆ SetClientCertificateId() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetClientCertificateId ( const char *  value)
inline

The identifier of a client certificate for an API stage.

Definition at line 104 of file GetStageResult.h.

◆ SetCreatedDate() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was created.

Definition at line 686 of file GetStageResult.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was created.

Definition at line 681 of file GetStageResult.h.

◆ SetDeploymentId() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetDeploymentId ( Aws::String &&  value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 63 of file GetStageResult.h.

◆ SetDeploymentId() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetDeploymentId ( const Aws::String value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 58 of file GetStageResult.h.

◆ SetDeploymentId() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetDeploymentId ( const char *  value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 68 of file GetStageResult.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetDescription ( Aws::String &&  value)
inline

The stage's description.

Definition at line 192 of file GetStageResult.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetDescription ( const Aws::String value)
inline

The stage's description.

Definition at line 187 of file GetStageResult.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetDescription ( const char *  value)
inline

The stage's description.

Definition at line 197 of file GetStageResult.h.

◆ SetDocumentationVersion() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetDocumentationVersion ( Aws::String &&  value)
inline

The version of the associated API documentation.

Definition at line 470 of file GetStageResult.h.

◆ SetDocumentationVersion() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetDocumentationVersion ( const Aws::String value)
inline

The version of the associated API documentation.

Definition at line 465 of file GetStageResult.h.

◆ SetDocumentationVersion() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetDocumentationVersion ( const char *  value)
inline

The version of the associated API documentation.

Definition at line 475 of file GetStageResult.h.

◆ SetLastUpdatedDate() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage last updated.

Definition at line 712 of file GetStageResult.h.

◆ SetLastUpdatedDate() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage last updated.

Definition at line 707 of file GetStageResult.h.

◆ SetMethodSettings() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetMethodSettings ( Aws::Map< Aws::String, MethodSetting > &&  value)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 305 of file GetStageResult.h.

◆ SetMethodSettings() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetMethodSettings ( const Aws::Map< Aws::String, MethodSetting > &  value)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 297 of file GetStageResult.h.

◆ SetStageName() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetStageName ( Aws::String &&  value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 144 of file GetStageResult.h.

◆ SetStageName() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetStageName ( const Aws::String value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 136 of file GetStageResult.h.

◆ SetStageName() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetStageName ( const char *  value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 152 of file GetStageResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 616 of file GetStageResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 610 of file GetStageResult.h.

◆ SetTracingEnabled()

void Aws::APIGateway::Model::GetStageResult::SetTracingEnabled ( bool  value)
inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 555 of file GetStageResult.h.

◆ SetVariables() [1/2]

void Aws::APIGateway::Model::GetStageResult::SetVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 391 of file GetStageResult.h.

◆ SetVariables() [2/2]

void Aws::APIGateway::Model::GetStageResult::SetVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 384 of file GetStageResult.h.

◆ SetWebAclArn() [1/3]

void Aws::APIGateway::Model::GetStageResult::SetWebAclArn ( Aws::String &&  value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 577 of file GetStageResult.h.

◆ SetWebAclArn() [2/3]

void Aws::APIGateway::Model::GetStageResult::SetWebAclArn ( const Aws::String value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 572 of file GetStageResult.h.

◆ SetWebAclArn() [3/3]

void Aws::APIGateway::Model::GetStageResult::SetWebAclArn ( const char *  value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 582 of file GetStageResult.h.

◆ WithAccessLogSettings() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithAccessLogSettings ( AccessLogSettings &&  value)
inline

Settings for logging access in this stage.

Definition at line 516 of file GetStageResult.h.

◆ WithAccessLogSettings() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithAccessLogSettings ( const AccessLogSettings value)
inline

Settings for logging access in this stage.

Definition at line 511 of file GetStageResult.h.

◆ WithCacheClusterEnabled()

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCacheClusterEnabled ( bool  value)
inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 228 of file GetStageResult.h.

◆ WithCacheClusterSize() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCacheClusterSize ( CacheClusterSize &&  value)
inline

The size of the cache cluster for the stage, if enabled.

Definition at line 254 of file GetStageResult.h.

◆ WithCacheClusterSize() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCacheClusterSize ( const CacheClusterSize value)
inline

The size of the cache cluster for the stage, if enabled.

Definition at line 249 of file GetStageResult.h.

◆ WithCacheClusterStatus() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCacheClusterStatus ( CacheClusterStatus &&  value)
inline

The status of the cache cluster for the stage, if enabled.

Definition at line 280 of file GetStageResult.h.

◆ WithCacheClusterStatus() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCacheClusterStatus ( const CacheClusterStatus value)
inline

The status of the cache cluster for the stage, if enabled.

Definition at line 275 of file GetStageResult.h.

◆ WithCanarySettings() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCanarySettings ( CanarySettings &&  value)
inline

Settings for the canary deployment in this stage.

Definition at line 542 of file GetStageResult.h.

◆ WithCanarySettings() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCanarySettings ( const CanarySettings value)
inline

Settings for the canary deployment in this stage.

Definition at line 537 of file GetStageResult.h.

◆ WithClientCertificateId() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithClientCertificateId ( Aws::String &&  value)
inline

The identifier of a client certificate for an API stage.

Definition at line 114 of file GetStageResult.h.

◆ WithClientCertificateId() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithClientCertificateId ( const Aws::String value)
inline

The identifier of a client certificate for an API stage.

Definition at line 109 of file GetStageResult.h.

◆ WithClientCertificateId() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithClientCertificateId ( const char *  value)
inline

The identifier of a client certificate for an API stage.

Definition at line 119 of file GetStageResult.h.

◆ WithCreatedDate() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was created.

Definition at line 696 of file GetStageResult.h.

◆ WithCreatedDate() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was created.

Definition at line 691 of file GetStageResult.h.

◆ WithDeploymentId() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDeploymentId ( Aws::String &&  value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 78 of file GetStageResult.h.

◆ WithDeploymentId() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDeploymentId ( const Aws::String value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 73 of file GetStageResult.h.

◆ WithDeploymentId() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDeploymentId ( const char *  value)
inline

The identifier of the Deployment that the stage points to.

Definition at line 83 of file GetStageResult.h.

◆ WithDescription() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDescription ( Aws::String &&  value)
inline

The stage's description.

Definition at line 207 of file GetStageResult.h.

◆ WithDescription() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDescription ( const Aws::String value)
inline

The stage's description.

Definition at line 202 of file GetStageResult.h.

◆ WithDescription() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDescription ( const char *  value)
inline

The stage's description.

Definition at line 212 of file GetStageResult.h.

◆ WithDocumentationVersion() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDocumentationVersion ( Aws::String &&  value)
inline

The version of the associated API documentation.

Definition at line 485 of file GetStageResult.h.

◆ WithDocumentationVersion() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDocumentationVersion ( const Aws::String value)
inline

The version of the associated API documentation.

Definition at line 480 of file GetStageResult.h.

◆ WithDocumentationVersion() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithDocumentationVersion ( const char *  value)
inline

The version of the associated API documentation.

Definition at line 490 of file GetStageResult.h.

◆ WithLastUpdatedDate() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage last updated.

Definition at line 722 of file GetStageResult.h.

◆ WithLastUpdatedDate() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage last updated.

Definition at line 717 of file GetStageResult.h.

◆ WithMethodSettings() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithMethodSettings ( Aws::Map< Aws::String, MethodSetting > &&  value)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 321 of file GetStageResult.h.

◆ WithMethodSettings() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithMethodSettings ( const Aws::Map< Aws::String, MethodSetting > &  value)
inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 313 of file GetStageResult.h.

◆ WithStageName() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithStageName ( Aws::String &&  value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 168 of file GetStageResult.h.

◆ WithStageName() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithStageName ( const Aws::String value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 160 of file GetStageResult.h.

◆ WithStageName() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithStageName ( const char *  value)
inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 176 of file GetStageResult.h.

◆ WithTags() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 628 of file GetStageResult.h.

◆ WithTags() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 622 of file GetStageResult.h.

◆ WithTracingEnabled()

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithTracingEnabled ( bool  value)
inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 561 of file GetStageResult.h.

◆ WithVariables() [1/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 405 of file GetStageResult.h.

◆ WithVariables() [2/2]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 398 of file GetStageResult.h.

◆ WithWebAclArn() [1/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithWebAclArn ( Aws::String &&  value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 592 of file GetStageResult.h.

◆ WithWebAclArn() [2/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithWebAclArn ( const Aws::String value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 587 of file GetStageResult.h.

◆ WithWebAclArn() [3/3]

GetStageResult& Aws::APIGateway::Model::GetStageResult::WithWebAclArn ( const char *  value)
inline

The ARN of the WebAcl associated with the Stage.

Definition at line 597 of file GetStageResult.h.


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