Class SignalExternalWorkflowExecutionDecisionAttributes

java.lang.Object
software.amazon.awssdk.services.swf.model.SignalExternalWorkflowExecutionDecisionAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SignalExternalWorkflowExecutionDecisionAttributes.Builder,SignalExternalWorkflowExecutionDecisionAttributes>
@Generated("software.amazon.awssdk:codegen") public final class SignalExternalWorkflowExecutionDecisionAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SignalExternalWorkflowExecutionDecisionAttributes.Builder,SignalExternalWorkflowExecutionDecisionAttributes>

Provides the details of the SignalExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

See Also:

  • Method Details

    • workflowId

      public final String workflowId()

      The workflowId of the workflow execution to be signaled.

      Returns:
      The workflowId of the workflow execution to be signaled.

    • runId

      public final String runId()

      The runId of the workflow execution to be signaled.

      Returns:
      The runId of the workflow execution to be signaled.

    • signalName

      public final String signalName()

      The name of the signal.The target workflow execution uses the signal name and input to process the signal.

      Returns:
      The name of the signal.The target workflow execution uses the signal name and input to process the signal.

    • input

      public final String input()

      The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

      Returns:
      The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

    • control

      public final String control()

      The data attached to the event that can be used by the decider in subsequent decision tasks.

      Returns:
      The data attached to the event that can be used by the decider in subsequent decision tasks.

    • toBuilder

      public SignalExternalWorkflowExecutionDecisionAttributes.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<SignalExternalWorkflowExecutionDecisionAttributes.Builder,SignalExternalWorkflowExecutionDecisionAttributes>
      Returns:
      a builder for type T

    • builder

      public static SignalExternalWorkflowExecutionDecisionAttributes.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.