@Generated(value="software.amazon.awssdk:codegen") public final class InvokeScreenAutomationRequest extends HoneycodeRequest implements ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
InvokeScreenAutomationRequest.Builder |
| 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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
boolean |
hasVariables()
For responses, this returns true if the service returned a value for the Variables property.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Map<String,VariableValue> |
variables()
Variables are specified as a map where the key is the name of the variable as defined on the screen.
|
String |
workbookId()
The ID of the workbook that contains the screen automation.
|
overrideConfigurationcopypublic final String workbookId()
The ID of the workbook that contains the screen automation.
public final String appId()
The ID of the app that contains the screen automation.
public final String screenId()
The ID of the screen that contains the screen automation.
public final String screenAutomationId()
The ID of the automation action to be performed.
public final boolean hasVariables()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,VariableValue> variables()
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. Any variables defined in a screen are required to be passed in the call.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVariables() method.
public final String rowId()
The row ID for the automation if the automation is defined inside a block with source or list.
public final 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.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
public InvokeScreenAutomationRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>toBuilder in class HoneycodeRequestpublic static InvokeScreenAutomationRequest.Builder builder()
public static Class<? extends InvokeScreenAutomationRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.