software.amazon.awssdk.services.honeycode.model

Class InvokeScreenAutomationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InvokeScreenAutomationRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	appId() The ID of the app that contains the screen automation.
static InvokeScreenAutomationRequest.Builder	builder()
String	clientRequestToken() The request token for performing the automation action.
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).
String	rowId() The row ID for the automation if the automation is defined inside a block with source or list.
String	screenAutomationId() The ID of the automation action to be performed.
String	screenId() The ID of the screen that contains the screen automation.
List<SdkField<?>>	sdkFields()
static Class<? extends InvokeScreenAutomationRequest.Builder>	serializableBuilderClass()
InvokeScreenAutomationRequest.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 automation.

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

Returns:

The ID of the workbook that contains the screen automation.

appId

public String appId()

The ID of the app that contains the screen automation.

Returns:

The ID of the app that contains the screen automation.

screenId

public String screenId()

The ID of the screen that contains the screen automation.

Returns:

The ID of the screen that contains the screen automation.

screenAutomationId

public String screenAutomationId()

The ID of the automation action to be performed.

Returns:

The ID of the automation action to be performed.

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.

rowId

public String rowId()

The row ID for the automation if the automation is defined inside a block with source or list.

Returns:

The row ID for the automation if the automation is defined inside a block with source or list.

clientRequestToken

public String clientRequestToken()

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

Returns:

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

toBuilder

public InvokeScreenAutomationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>

Specified by:

toBuilder in class HoneycodeRequest

builder

public static InvokeScreenAutomationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends InvokeScreenAutomationRequest.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