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

#include <GetApiKeyResult.h>

Public Member Functions

 GetApiKeyResult ()
 
 GetApiKeyResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetApiKeyResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
GetApiKeyResultWithId (const Aws::String &value)
 
GetApiKeyResultWithId (Aws::String &&value)
 
GetApiKeyResultWithId (const char *value)
 
const Aws::StringGetValue () const
 
void SetValue (const Aws::String &value)
 
void SetValue (Aws::String &&value)
 
void SetValue (const char *value)
 
GetApiKeyResultWithValue (const Aws::String &value)
 
GetApiKeyResultWithValue (Aws::String &&value)
 
GetApiKeyResultWithValue (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetApiKeyResultWithName (const Aws::String &value)
 
GetApiKeyResultWithName (Aws::String &&value)
 
GetApiKeyResultWithName (const char *value)
 
const Aws::StringGetCustomerId () const
 
void SetCustomerId (const Aws::String &value)
 
void SetCustomerId (Aws::String &&value)
 
void SetCustomerId (const char *value)
 
GetApiKeyResultWithCustomerId (const Aws::String &value)
 
GetApiKeyResultWithCustomerId (Aws::String &&value)
 
GetApiKeyResultWithCustomerId (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetApiKeyResultWithDescription (const Aws::String &value)
 
GetApiKeyResultWithDescription (Aws::String &&value)
 
GetApiKeyResultWithDescription (const char *value)
 
bool GetEnabled () const
 
void SetEnabled (bool value)
 
GetApiKeyResultWithEnabled (bool value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
GetApiKeyResultWithCreatedDate (const Aws::Utils::DateTime &value)
 
GetApiKeyResultWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
GetApiKeyResultWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
GetApiKeyResultWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Vector< Aws::String > & GetStageKeys () const
 
void SetStageKeys (const Aws::Vector< Aws::String > &value)
 
void SetStageKeys (Aws::Vector< Aws::String > &&value)
 
GetApiKeyResultWithStageKeys (const Aws::Vector< Aws::String > &value)
 
GetApiKeyResultWithStageKeys (Aws::Vector< Aws::String > &&value)
 
GetApiKeyResultAddStageKeys (const Aws::String &value)
 
GetApiKeyResultAddStageKeys (Aws::String &&value)
 
GetApiKeyResultAddStageKeys (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)
 
GetApiKeyResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
GetApiKeyResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetApiKeyResultAddTags (const Aws::String &key, const Aws::String &value)
 
GetApiKeyResultAddTags (Aws::String &&key, const Aws::String &value)
 
GetApiKeyResultAddTags (const Aws::String &key, Aws::String &&value)
 
GetApiKeyResultAddTags (Aws::String &&key, Aws::String &&value)
 
GetApiKeyResultAddTags (const char *key, Aws::String &&value)
 
GetApiKeyResultAddTags (Aws::String &&key, const char *value)
 
GetApiKeyResultAddTags (const char *key, const char *value)
 

Detailed Description

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See Also:

AWS API Reference

Definition at line 40 of file GetApiKeyResult.h.

Constructor & Destructor Documentation

◆ GetApiKeyResult() [1/2]

Aws::APIGateway::Model::GetApiKeyResult::GetApiKeyResult ( )

◆ GetApiKeyResult() [2/2]

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

Member Function Documentation

◆ AddStageKeys() [1/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::AddStageKeys ( Aws::String &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 343 of file GetApiKeyResult.h.

◆ AddStageKeys() [2/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::AddStageKeys ( const Aws::String value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 337 of file GetApiKeyResult.h.

◆ AddStageKeys() [3/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::AddStageKeys ( const char *  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 349 of file GetApiKeyResult.h.

◆ AddTags() [1/7]

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

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

Definition at line 404 of file GetApiKeyResult.h.

◆ AddTags() [2/7]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::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 392 of file GetApiKeyResult.h.

◆ AddTags() [3/7]

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

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

Definition at line 416 of file GetApiKeyResult.h.

◆ AddTags() [4/7]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::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 398 of file GetApiKeyResult.h.

◆ AddTags() [5/7]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::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 386 of file GetApiKeyResult.h.

◆ AddTags() [6/7]

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

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

Definition at line 410 of file GetApiKeyResult.h.

◆ AddTags() [7/7]

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

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

Definition at line 422 of file GetApiKeyResult.h.

◆ GetCreatedDate()

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

The timestamp when the API Key was created.

Definition at line 254 of file GetApiKeyResult.h.

◆ GetCustomerId()

const Aws::String& Aws::APIGateway::Model::GetApiKeyResult::GetCustomerId ( ) const
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 160 of file GetApiKeyResult.h.

◆ GetDescription()

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

The description of the API Key.

Definition at line 202 of file GetApiKeyResult.h.

◆ GetEnabled()

bool Aws::APIGateway::Model::GetApiKeyResult::GetEnabled ( ) const
inline

Specifies whether the API Key can be used by callers.

Definition at line 238 of file GetApiKeyResult.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::GetApiKeyResult::GetId ( ) const
inline

The identifier of the API Key.

Definition at line 51 of file GetApiKeyResult.h.

◆ GetLastUpdatedDate()

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

The timestamp when the API Key was last updated.

Definition at line 280 of file GetApiKeyResult.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::GetApiKeyResult::GetName ( ) const
inline

The name of the API Key.

Definition at line 123 of file GetApiKeyResult.h.

◆ GetStageKeys()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::GetApiKeyResult::GetStageKeys ( ) const
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 307 of file GetApiKeyResult.h.

◆ GetTags()

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

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

Definition at line 356 of file GetApiKeyResult.h.

◆ GetValue()

const Aws::String& Aws::APIGateway::Model::GetApiKeyResult::GetValue ( ) const
inline

The value of the API Key.

Definition at line 87 of file GetApiKeyResult.h.

◆ operator=()

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

◆ SetCreatedDate() [1/2]

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

The timestamp when the API Key was created.

Definition at line 264 of file GetApiKeyResult.h.

◆ SetCreatedDate() [2/2]

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

The timestamp when the API Key was created.

Definition at line 259 of file GetApiKeyResult.h.

◆ SetCustomerId() [1/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetCustomerId ( Aws::String &&  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 172 of file GetApiKeyResult.h.

◆ SetCustomerId() [2/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetCustomerId ( const Aws::String value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 166 of file GetApiKeyResult.h.

◆ SetCustomerId() [3/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetCustomerId ( const char *  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 178 of file GetApiKeyResult.h.

◆ SetDescription() [1/3]

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

The description of the API Key.

Definition at line 212 of file GetApiKeyResult.h.

◆ SetDescription() [2/3]

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

The description of the API Key.

Definition at line 207 of file GetApiKeyResult.h.

◆ SetDescription() [3/3]

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

The description of the API Key.

Definition at line 217 of file GetApiKeyResult.h.

◆ SetEnabled()

void Aws::APIGateway::Model::GetApiKeyResult::SetEnabled ( bool  value)
inline

Specifies whether the API Key can be used by callers.

Definition at line 243 of file GetApiKeyResult.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetId ( Aws::String &&  value)
inline

The identifier of the API Key.

Definition at line 61 of file GetApiKeyResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetId ( const Aws::String value)
inline

The identifier of the API Key.

Definition at line 56 of file GetApiKeyResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetId ( const char *  value)
inline

The identifier of the API Key.

Definition at line 66 of file GetApiKeyResult.h.

◆ SetLastUpdatedDate() [1/2]

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

The timestamp when the API Key was last updated.

Definition at line 290 of file GetApiKeyResult.h.

◆ SetLastUpdatedDate() [2/2]

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

The timestamp when the API Key was last updated.

Definition at line 285 of file GetApiKeyResult.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetName ( Aws::String &&  value)
inline

The name of the API Key.

Definition at line 133 of file GetApiKeyResult.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetName ( const Aws::String value)
inline

The name of the API Key.

Definition at line 128 of file GetApiKeyResult.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetName ( const char *  value)
inline

The name of the API Key.

Definition at line 138 of file GetApiKeyResult.h.

◆ SetStageKeys() [1/2]

void Aws::APIGateway::Model::GetApiKeyResult::SetStageKeys ( Aws::Vector< Aws::String > &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 319 of file GetApiKeyResult.h.

◆ SetStageKeys() [2/2]

void Aws::APIGateway::Model::GetApiKeyResult::SetStageKeys ( const Aws::Vector< Aws::String > &  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 313 of file GetApiKeyResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::GetApiKeyResult::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 368 of file GetApiKeyResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::GetApiKeyResult::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 362 of file GetApiKeyResult.h.

◆ SetValue() [1/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetValue ( Aws::String &&  value)
inline

The value of the API Key.

Definition at line 97 of file GetApiKeyResult.h.

◆ SetValue() [2/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetValue ( const Aws::String value)
inline

The value of the API Key.

Definition at line 92 of file GetApiKeyResult.h.

◆ SetValue() [3/3]

void Aws::APIGateway::Model::GetApiKeyResult::SetValue ( const char *  value)
inline

The value of the API Key.

Definition at line 102 of file GetApiKeyResult.h.

◆ WithCreatedDate() [1/2]

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

The timestamp when the API Key was created.

Definition at line 274 of file GetApiKeyResult.h.

◆ WithCreatedDate() [2/2]

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

The timestamp when the API Key was created.

Definition at line 269 of file GetApiKeyResult.h.

◆ WithCustomerId() [1/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithCustomerId ( Aws::String &&  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 190 of file GetApiKeyResult.h.

◆ WithCustomerId() [2/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithCustomerId ( const Aws::String value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 184 of file GetApiKeyResult.h.

◆ WithCustomerId() [3/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithCustomerId ( const char *  value)
inline

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Definition at line 196 of file GetApiKeyResult.h.

◆ WithDescription() [1/3]

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

The description of the API Key.

Definition at line 227 of file GetApiKeyResult.h.

◆ WithDescription() [2/3]

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

The description of the API Key.

Definition at line 222 of file GetApiKeyResult.h.

◆ WithDescription() [3/3]

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

The description of the API Key.

Definition at line 232 of file GetApiKeyResult.h.

◆ WithEnabled()

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithEnabled ( bool  value)
inline

Specifies whether the API Key can be used by callers.

Definition at line 248 of file GetApiKeyResult.h.

◆ WithId() [1/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithId ( Aws::String &&  value)
inline

The identifier of the API Key.

Definition at line 76 of file GetApiKeyResult.h.

◆ WithId() [2/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithId ( const Aws::String value)
inline

The identifier of the API Key.

Definition at line 71 of file GetApiKeyResult.h.

◆ WithId() [3/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithId ( const char *  value)
inline

The identifier of the API Key.

Definition at line 81 of file GetApiKeyResult.h.

◆ WithLastUpdatedDate() [1/2]

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

The timestamp when the API Key was last updated.

Definition at line 300 of file GetApiKeyResult.h.

◆ WithLastUpdatedDate() [2/2]

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

The timestamp when the API Key was last updated.

Definition at line 295 of file GetApiKeyResult.h.

◆ WithName() [1/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithName ( Aws::String &&  value)
inline

The name of the API Key.

Definition at line 148 of file GetApiKeyResult.h.

◆ WithName() [2/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithName ( const Aws::String value)
inline

The name of the API Key.

Definition at line 143 of file GetApiKeyResult.h.

◆ WithName() [3/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithName ( const char *  value)
inline

The name of the API Key.

Definition at line 153 of file GetApiKeyResult.h.

◆ WithStageKeys() [1/2]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithStageKeys ( Aws::Vector< Aws::String > &&  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 331 of file GetApiKeyResult.h.

◆ WithStageKeys() [2/2]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithStageKeys ( const Aws::Vector< Aws::String > &  value)
inline

A list of Stage resources that are associated with the ApiKey resource.

Definition at line 325 of file GetApiKeyResult.h.

◆ WithTags() [1/2]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::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 380 of file GetApiKeyResult.h.

◆ WithTags() [2/2]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::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 374 of file GetApiKeyResult.h.

◆ WithValue() [1/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithValue ( Aws::String &&  value)
inline

The value of the API Key.

Definition at line 112 of file GetApiKeyResult.h.

◆ WithValue() [2/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithValue ( const Aws::String value)
inline

The value of the API Key.

Definition at line 107 of file GetApiKeyResult.h.

◆ WithValue() [3/3]

GetApiKeyResult& Aws::APIGateway::Model::GetApiKeyResult::WithValue ( const char *  value)
inline

The value of the API Key.

Definition at line 117 of file GetApiKeyResult.h.


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