AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::Route53Domains::Model::GetDomainSuggestionsRequest Class Reference

#include <GetDomainSuggestionsRequest.h>

+ Inheritance diagram for Aws::Route53Domains::Model::GetDomainSuggestionsRequest:

Public Member Functions

 GetDomainSuggestionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () 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)
 
GetDomainSuggestionsRequestWithDomainName (const Aws::String &value)
 
GetDomainSuggestionsRequestWithDomainName (Aws::String &&value)
 
GetDomainSuggestionsRequestWithDomainName (const char *value)
 
int GetSuggestionCount () const
 
bool SuggestionCountHasBeenSet () const
 
void SetSuggestionCount (int value)
 
GetDomainSuggestionsRequestWithSuggestionCount (int value)
 
bool GetOnlyAvailable () const
 
bool OnlyAvailableHasBeenSet () const
 
void SetOnlyAvailable (bool value)
 
GetDomainSuggestionsRequestWithOnlyAvailable (bool value)
 
- Public Member Functions inherited from Aws::Route53Domains::Route53DomainsRequest
virtual ~Route53DomainsRequest ()
 
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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file GetDomainSuggestionsRequest.h.

Constructor & Destructor Documentation

◆ GetDomainSuggestionsRequest()

Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetDomainSuggestionsRequest ( )

Member Function Documentation

◆ DomainNameHasBeenSet()

bool Aws::Route53Domains::Model::GetDomainSuggestionsRequest::DomainNameHasBeenSet ( ) const
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 73 of file GetDomainSuggestionsRequest.h.

◆ GetDomainName()

const Aws::String& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetDomainName ( ) const
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 54 of file GetDomainSuggestionsRequest.h.

◆ GetOnlyAvailable()

bool Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetOnlyAvailable ( ) const
inline

If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

Definition at line 223 of file GetDomainSuggestionsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetDomainSuggestionsRequest.h.

◆ GetSuggestionCount()

int Aws::Route53Domains::Model::GetDomainSuggestionsRequest::GetSuggestionCount ( ) const
inline

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

Definition at line 194 of file GetDomainSuggestionsRequest.h.

◆ OnlyAvailableHasBeenSet()

bool Aws::Route53Domains::Model::GetDomainSuggestionsRequest::OnlyAvailableHasBeenSet ( ) const
inline

If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

Definition at line 233 of file GetDomainSuggestionsRequest.h.

◆ SerializePayload()

Aws::String Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDomainName() [1/3]

void Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SetDomainName ( Aws::String &&  value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 111 of file GetDomainSuggestionsRequest.h.

◆ SetDomainName() [2/3]

void Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SetDomainName ( const Aws::String value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 92 of file GetDomainSuggestionsRequest.h.

◆ SetDomainName() [3/3]

void Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SetDomainName ( const char *  value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 130 of file GetDomainSuggestionsRequest.h.

◆ SetOnlyAvailable()

void Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SetOnlyAvailable ( bool  value)
inline

If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

Definition at line 243 of file GetDomainSuggestionsRequest.h.

◆ SetSuggestionCount()

void Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SetSuggestionCount ( int  value)
inline

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

Definition at line 206 of file GetDomainSuggestionsRequest.h.

◆ SuggestionCountHasBeenSet()

bool Aws::Route53Domains::Model::GetDomainSuggestionsRequest::SuggestionCountHasBeenSet ( ) const
inline

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

Definition at line 200 of file GetDomainSuggestionsRequest.h.

◆ WithDomainName() [1/3]

GetDomainSuggestionsRequest& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::WithDomainName ( Aws::String &&  value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 168 of file GetDomainSuggestionsRequest.h.

◆ WithDomainName() [2/3]

GetDomainSuggestionsRequest& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::WithDomainName ( const Aws::String value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 149 of file GetDomainSuggestionsRequest.h.

◆ WithDomainName() [3/3]

GetDomainSuggestionsRequest& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::WithDomainName ( const char *  value)
inline

A domain name that you want to use as the basis for a list of possible domain names. The top-level domain (TLD), such as .com, must be a TLD that Route 53 supports. For a list of supported TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

The domain name can contain only the following characters:

  • Letters a through z. Domain names are not case sensitive.

  • Numbers 0 through 9.

  • Hyphen (-). You can't specify a hyphen at the beginning or end of a label.

  • Period (.) to separate the labels in the name, such as the . in example.com.

Internationalized domain names are not supported for some top-level domains. To determine whether the TLD that you want to use supports internationalized domain names, see Domains that You Can Register with Amazon Route 53.

Definition at line 187 of file GetDomainSuggestionsRequest.h.

◆ WithOnlyAvailable()

GetDomainSuggestionsRequest& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::WithOnlyAvailable ( bool  value)
inline

If OnlyAvailable is true, Route 53 returns only domain names that are available. If OnlyAvailable is false, Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

Definition at line 253 of file GetDomainSuggestionsRequest.h.

◆ WithSuggestionCount()

GetDomainSuggestionsRequest& Aws::Route53Domains::Model::GetDomainSuggestionsRequest::WithSuggestionCount ( int  value)
inline

The number of suggested domain names that you want Route 53 to return. Specify a value between 1 and 50.

Definition at line 212 of file GetDomainSuggestionsRequest.h.


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