AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::Honeycode::Model::GetScreenDataRequest Class Reference

#include <GetScreenDataRequest.h>

+ Inheritance diagram for Aws::Honeycode::Model::GetScreenDataRequest:

Public Member Functions

 GetScreenDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetWorkbookId () const
 
bool WorkbookIdHasBeenSet () const
 
void SetWorkbookId (const Aws::String &value)
 
void SetWorkbookId (Aws::String &&value)
 
void SetWorkbookId (const char *value)
 
GetScreenDataRequestWithWorkbookId (const Aws::String &value)
 
GetScreenDataRequestWithWorkbookId (Aws::String &&value)
 
GetScreenDataRequestWithWorkbookId (const char *value)
 
const Aws::StringGetAppId () const
 
bool AppIdHasBeenSet () const
 
void SetAppId (const Aws::String &value)
 
void SetAppId (Aws::String &&value)
 
void SetAppId (const char *value)
 
GetScreenDataRequestWithAppId (const Aws::String &value)
 
GetScreenDataRequestWithAppId (Aws::String &&value)
 
GetScreenDataRequestWithAppId (const char *value)
 
const Aws::StringGetScreenId () const
 
bool ScreenIdHasBeenSet () const
 
void SetScreenId (const Aws::String &value)
 
void SetScreenId (Aws::String &&value)
 
void SetScreenId (const char *value)
 
GetScreenDataRequestWithScreenId (const Aws::String &value)
 
GetScreenDataRequestWithScreenId (Aws::String &&value)
 
GetScreenDataRequestWithScreenId (const char *value)
 
const Aws::Map< Aws::String, VariableValue > & GetVariables () const
 
bool VariablesHasBeenSet () const
 
void SetVariables (const Aws::Map< Aws::String, VariableValue > &value)
 
void SetVariables (Aws::Map< Aws::String, VariableValue > &&value)
 
GetScreenDataRequestWithVariables (const Aws::Map< Aws::String, VariableValue > &value)
 
GetScreenDataRequestWithVariables (Aws::Map< Aws::String, VariableValue > &&value)
 
GetScreenDataRequestAddVariables (const Aws::String &key, const VariableValue &value)
 
GetScreenDataRequestAddVariables (Aws::String &&key, const VariableValue &value)
 
GetScreenDataRequestAddVariables (const Aws::String &key, VariableValue &&value)
 
GetScreenDataRequestAddVariables (Aws::String &&key, VariableValue &&value)
 
GetScreenDataRequestAddVariables (const char *key, VariableValue &&value)
 
GetScreenDataRequestAddVariables (const char *key, const VariableValue &value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetScreenDataRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetScreenDataRequestWithNextToken (const Aws::String &value)
 
GetScreenDataRequestWithNextToken (Aws::String &&value)
 
GetScreenDataRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::Honeycode::HoneycodeRequest
virtual ~HoneycodeRequest ()
 
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::Honeycode::HoneycodeRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file GetScreenDataRequest.h.

Constructor & Destructor Documentation

◆ GetScreenDataRequest()

Aws::Honeycode::Model::GetScreenDataRequest::GetScreenDataRequest ( )

Member Function Documentation

◆ AddVariables() [1/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( const Aws::String key,
const VariableValue value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 221 of file GetScreenDataRequest.h.

◆ AddVariables() [2/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( Aws::String &&  key,
const VariableValue value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 230 of file GetScreenDataRequest.h.

◆ AddVariables() [3/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( const Aws::String key,
VariableValue &&  value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 239 of file GetScreenDataRequest.h.

◆ AddVariables() [4/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( Aws::String &&  key,
VariableValue &&  value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 248 of file GetScreenDataRequest.h.

◆ AddVariables() [5/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( const char *  key,
VariableValue &&  value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 257 of file GetScreenDataRequest.h.

◆ AddVariables() [6/6]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::AddVariables ( const char *  key,
const VariableValue value 
)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 266 of file GetScreenDataRequest.h.

◆ AppIdHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::AppIdHasBeenSet ( ) const
inline

The ID of the app that contains the screem.

Definition at line 86 of file GetScreenDataRequest.h.

◆ GetAppId()

const Aws::String& Aws::Honeycode::Model::GetScreenDataRequest::GetAppId ( ) const
inline

The ID of the app that contains the screem.

Definition at line 81 of file GetScreenDataRequest.h.

◆ GetMaxResults()

int Aws::Honeycode::Model::GetScreenDataRequest::GetMaxResults ( ) const
inline

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

Definition at line 275 of file GetScreenDataRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Honeycode::Model::GetScreenDataRequest::GetNextToken ( ) const
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 308 of file GetScreenDataRequest.h.

◆ GetScreenId()

const Aws::String& Aws::Honeycode::Model::GetScreenDataRequest::GetScreenId ( ) const
inline

The ID of the screen.

Definition at line 122 of file GetScreenDataRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Honeycode::Model::GetScreenDataRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetScreenDataRequest.h.

◆ GetVariables()

const Aws::Map<Aws::String, VariableValue>& Aws::Honeycode::Model::GetScreenDataRequest::GetVariables ( ) const
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 167 of file GetScreenDataRequest.h.

◆ GetWorkbookId()

const Aws::String& Aws::Honeycode::Model::GetScreenDataRequest::GetWorkbookId ( ) const
inline

The ID of the workbook that contains the screen.

Definition at line 40 of file GetScreenDataRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::MaxResultsHasBeenSet ( ) const
inline

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

Definition at line 283 of file GetScreenDataRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::NextTokenHasBeenSet ( ) const
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 316 of file GetScreenDataRequest.h.

◆ ScreenIdHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::ScreenIdHasBeenSet ( ) const
inline

The ID of the screen.

Definition at line 127 of file GetScreenDataRequest.h.

◆ SerializePayload()

Aws::String Aws::Honeycode::Model::GetScreenDataRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAppId() [1/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetAppId ( const Aws::String value)
inline

The ID of the app that contains the screem.

Definition at line 91 of file GetScreenDataRequest.h.

◆ SetAppId() [2/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetAppId ( Aws::String &&  value)
inline

The ID of the app that contains the screem.

Definition at line 96 of file GetScreenDataRequest.h.

◆ SetAppId() [3/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetAppId ( const char *  value)
inline

The ID of the app that contains the screem.

Definition at line 101 of file GetScreenDataRequest.h.

◆ SetMaxResults()

void Aws::Honeycode::Model::GetScreenDataRequest::SetMaxResults ( int  value)
inline

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

Definition at line 291 of file GetScreenDataRequest.h.

◆ SetNextToken() [1/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetNextToken ( const Aws::String value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 324 of file GetScreenDataRequest.h.

◆ SetNextToken() [2/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetNextToken ( Aws::String &&  value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 332 of file GetScreenDataRequest.h.

◆ SetNextToken() [3/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetNextToken ( const char *  value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 340 of file GetScreenDataRequest.h.

◆ SetScreenId() [1/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetScreenId ( const Aws::String value)
inline

The ID of the screen.

Definition at line 132 of file GetScreenDataRequest.h.

◆ SetScreenId() [2/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetScreenId ( Aws::String &&  value)
inline

The ID of the screen.

Definition at line 137 of file GetScreenDataRequest.h.

◆ SetScreenId() [3/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetScreenId ( const char *  value)
inline

The ID of the screen.

Definition at line 142 of file GetScreenDataRequest.h.

◆ SetVariables() [1/2]

void Aws::Honeycode::Model::GetScreenDataRequest::SetVariables ( const Aws::Map< Aws::String, VariableValue > &  value)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 185 of file GetScreenDataRequest.h.

◆ SetVariables() [2/2]

void Aws::Honeycode::Model::GetScreenDataRequest::SetVariables ( Aws::Map< Aws::String, VariableValue > &&  value)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 194 of file GetScreenDataRequest.h.

◆ SetWorkbookId() [1/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetWorkbookId ( const Aws::String value)
inline

The ID of the workbook that contains the screen.

Definition at line 50 of file GetScreenDataRequest.h.

◆ SetWorkbookId() [2/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetWorkbookId ( Aws::String &&  value)
inline

The ID of the workbook that contains the screen.

Definition at line 55 of file GetScreenDataRequest.h.

◆ SetWorkbookId() [3/3]

void Aws::Honeycode::Model::GetScreenDataRequest::SetWorkbookId ( const char *  value)
inline

The ID of the workbook that contains the screen.

Definition at line 60 of file GetScreenDataRequest.h.

◆ VariablesHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::VariablesHasBeenSet ( ) const
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 176 of file GetScreenDataRequest.h.

◆ WithAppId() [1/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithAppId ( const Aws::String value)
inline

The ID of the app that contains the screem.

Definition at line 106 of file GetScreenDataRequest.h.

◆ WithAppId() [2/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithAppId ( Aws::String &&  value)
inline

The ID of the app that contains the screem.

Definition at line 111 of file GetScreenDataRequest.h.

◆ WithAppId() [3/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithAppId ( const char *  value)
inline

The ID of the app that contains the screem.

Definition at line 116 of file GetScreenDataRequest.h.

◆ WithMaxResults()

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithMaxResults ( int  value)
inline

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

Definition at line 299 of file GetScreenDataRequest.h.

◆ WithNextToken() [1/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithNextToken ( const Aws::String value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 348 of file GetScreenDataRequest.h.

◆ WithNextToken() [2/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithNextToken ( Aws::String &&  value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 356 of file GetScreenDataRequest.h.

◆ WithNextToken() [3/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithNextToken ( const char *  value)
inline

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

Definition at line 364 of file GetScreenDataRequest.h.

◆ WithScreenId() [1/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithScreenId ( const Aws::String value)
inline

The ID of the screen.

Definition at line 147 of file GetScreenDataRequest.h.

◆ WithScreenId() [2/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithScreenId ( Aws::String &&  value)
inline

The ID of the screen.

Definition at line 152 of file GetScreenDataRequest.h.

◆ WithScreenId() [3/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithScreenId ( const char *  value)
inline

The ID of the screen.

Definition at line 157 of file GetScreenDataRequest.h.

◆ WithVariables() [1/2]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithVariables ( const Aws::Map< Aws::String, VariableValue > &  value)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 203 of file GetScreenDataRequest.h.

◆ WithVariables() [2/2]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithVariables ( Aws::Map< Aws::String, VariableValue > &&  value)
inline

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

Definition at line 212 of file GetScreenDataRequest.h.

◆ WithWorkbookId() [1/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithWorkbookId ( const Aws::String value)
inline

The ID of the workbook that contains the screen.

Definition at line 65 of file GetScreenDataRequest.h.

◆ WithWorkbookId() [2/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithWorkbookId ( Aws::String &&  value)
inline

The ID of the workbook that contains the screen.

Definition at line 70 of file GetScreenDataRequest.h.

◆ WithWorkbookId() [3/3]

GetScreenDataRequest& Aws::Honeycode::Model::GetScreenDataRequest::WithWorkbookId ( const char *  value)
inline

The ID of the workbook that contains the screen.

Definition at line 75 of file GetScreenDataRequest.h.

◆ WorkbookIdHasBeenSet()

bool Aws::Honeycode::Model::GetScreenDataRequest::WorkbookIdHasBeenSet ( ) const
inline

The ID of the workbook that contains the screen.

Definition at line 45 of file GetScreenDataRequest.h.


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