Package 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("software.amazon.awssdk:codegen") public final class InvokeScreenAutomationRequest extends HoneycodeRequest implements ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>

  • Method Details

    • workbookId

      public final 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 final 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 final 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 final String screenAutomationId()

      The ID of the automation action to be performed.

      Returns:
      The ID of the automation action to be performed.

    • hasVariables

      public final boolean hasVariables()
      For responses, this returns true if the service returned a value for the Variables property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • variables

      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.

      Returns:
      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.

    • rowId

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

      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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InvokeScreenAutomationRequest.Builder,InvokeScreenAutomationRequest>
      Specified by:
      toBuilder in class HoneycodeRequest
      Returns:
      a builder for type T

    • builder

      public static InvokeScreenAutomationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.