com.amazonaws.services.honeycode.model

Class GetScreenDataRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.honeycode.model.GetScreenDataRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetScreenDataRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetScreenDataRequest()

Method Summary

Modifier and Type	Method and Description
GetScreenDataRequest	addVariablesEntry(String key, VariableValue value) Add a single Variables entry
GetScreenDataRequest	clearVariablesEntries() Removes all the entries added into Variables.
GetScreenDataRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAppId() The ID of the app that contains the screem.
Integer	getMaxResults() The number of results to be returned on a single page.
String	getNextToken() This parameter is optional.
String	getScreenId() The ID of the screen.
Map<String,VariableValue>	getVariables() Variables are optional and are needed only if the screen requires them to render correctly.
String	getWorkbookId() The ID of the workbook that contains the screen.
int	hashCode()
void	setAppId(String appId) The ID of the app that contains the screem.
void	setMaxResults(Integer maxResults) The number of results to be returned on a single page.
void	setNextToken(String nextToken) This parameter is optional.
void	setScreenId(String screenId) The ID of the screen.
void	setVariables(Map<String,VariableValue> variables) Variables are optional and are needed only if the screen requires them to render correctly.
void	setWorkbookId(String workbookId) The ID of the workbook that contains the screen.
String	toString() Returns a string representation of this object.
GetScreenDataRequest	withAppId(String appId) The ID of the app that contains the screem.
GetScreenDataRequest	withMaxResults(Integer maxResults) The number of results to be returned on a single page.
GetScreenDataRequest	withNextToken(String nextToken) This parameter is optional.
GetScreenDataRequest	withScreenId(String screenId) The ID of the screen.
GetScreenDataRequest	withVariables(Map<String,VariableValue> variables) Variables are optional and are needed only if the screen requires them to render correctly.
GetScreenDataRequest	withWorkbookId(String workbookId) The ID of the workbook that contains the screen.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetScreenDataRequest

public GetScreenDataRequest()

Method Detail

setWorkbookId

public void setWorkbookId(String workbookId)

The ID of the workbook that contains the screen.

Parameters:

workbookId - The ID of the workbook that contains the screen.

getWorkbookId

public String getWorkbookId()

The ID of the workbook that contains the screen.

Returns:

The ID of the workbook that contains the screen.

withWorkbookId

public GetScreenDataRequest withWorkbookId(String workbookId)

The ID of the workbook that contains the screen.

Parameters:

workbookId - The ID of the workbook that contains the screen.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAppId

public void setAppId(String appId)

The ID of the app that contains the screem.

Parameters:

appId - The ID of the app that contains the screem.

getAppId

public String getAppId()

The ID of the app that contains the screem.

Returns:

The ID of the app that contains the screem.

withAppId

public GetScreenDataRequest withAppId(String appId)

The ID of the app that contains the screem.

Parameters:

appId - The ID of the app that contains the screem.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScreenId

public void setScreenId(String screenId)

The ID of the screen.

Parameters:

screenId - The ID of the screen.

getScreenId

public String getScreenId()

The ID of the screen.

Returns:

The ID of the screen.

withScreenId

public GetScreenDataRequest withScreenId(String screenId)

The ID of the screen.

Parameters:

screenId - The ID of the screen.

Returns:

Returns a reference to this object so that method calls can be chained together.

getVariables

public Map<String,VariableValue> getVariables()

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.

Returns:

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.

setVariables

public void setVariables(Map<String,VariableValue> variables)

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.

Parameters:

variables - 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.

withVariables

public GetScreenDataRequest withVariables(Map<String,VariableValue> variables)

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.

Parameters:

variables - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addVariablesEntry

public GetScreenDataRequest addVariablesEntry(String key,
                                              VariableValue value)

Add a single Variables entry

See Also:

withVariables(java.util.Map<java.lang.String, com.amazonaws.services.honeycode.model.VariableValue>)

clearVariablesEntries

public GetScreenDataRequest clearVariablesEntries()

Removes all the entries added into Variables.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

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.

Parameters:

maxResults - 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.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

withMaxResults

public GetScreenDataRequest withMaxResults(Integer maxResults)

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.

Parameters:

maxResults - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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.

Parameters:

nextToken - 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.

getNextToken

public String getNextToken()

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.

Returns:

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.

withNextToken

public GetScreenDataRequest withNextToken(String nextToken)

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.

Parameters:

nextToken - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetScreenDataRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()