software.amazon.awssdk.services.honeycode.model

Class GetScreenDataRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.honeycode.model.HoneycodeRequest

software.amazon.awssdk.services.honeycode.model.GetScreenDataRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetScreenDataRequest
extends HoneycodeRequest
implements ToCopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetScreenDataRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The ID of the app that contains the screem.
static GetScreenDataRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVariables() Returns true if the Variables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxResults() The number of results to be returned on a single page.
String	nextToken() This parameter is optional.
String	screenId() The ID of the screen.
List<SdkField<?>>	sdkFields()
static Class<? extends GetScreenDataRequest.Builder>	serializableBuilderClass()
GetScreenDataRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,VariableValue>	variables() Variables are optional and are needed only if the screen requires them to render correctly.
String	workbookId() The ID of the workbook that contains the screen.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workbookId

public String workbookId()

The ID of the workbook that contains the screen.

Returns:

The ID of the workbook that contains the screen.

appId

public String appId()

The ID of the app that contains the screem.

Returns:

The ID of the app that contains the screem.

screenId

public String screenId()

The ID of the screen.

Returns:

The ID of the screen.

hasVariables

public boolean hasVariables()

Returns true if the Variables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

variables

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasVariables() to see if a value was sent in this field.

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.

maxResults

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

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.

nextToken

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

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.

toBuilder

public GetScreenDataRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>

Specified by:

toBuilder in class HoneycodeRequest

builder

public static GetScreenDataRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetScreenDataRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo