Class SignalExternalWorkflowExecutionFailedEventAttributes

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

Provides the details of the SignalExternalWorkflowExecutionFailed event.

See Also:

  • Method Details

    • workflowId

      public final String workflowId()

      The workflowId of the external workflow execution that the signal was being delivered to.

      Returns:
      The workflowId of the external workflow execution that the signal was being delivered to.

    • runId

      public final String runId()

      The runId of the external workflow execution that the signal was being delivered to.

      Returns:
      The runId of the external workflow execution that the signal was being delivered to.

    • cause

      public final SignalExternalWorkflowExecutionFailedCause cause()

      The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

      If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, cause() will return SignalExternalWorkflowExecutionFailedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

      Returns:
      The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

      If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

      See Also:

    • causeAsString

      public final String causeAsString()

      The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

      If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, cause() will return SignalExternalWorkflowExecutionFailedCause.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from causeAsString().

      Returns:
      The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

      If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

      See Also:

    • initiatedEventId

      public final Long initiatedEventId()

      The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

      Returns:
      The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • decisionTaskCompletedEventId

      public final Long decisionTaskCompletedEventId()

      The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

      Returns:
      The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • control

      public final String control()

      The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

      Returns:
      The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

    • toBuilder

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

    • builder

      public static SignalExternalWorkflowExecutionFailedEventAttributes.Builder builder()

    • serializableBuilderClass

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