Package software.amazon.awssdk.services.swf.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignalExternalWorkflowExecutionFailedEventAttributes.Builder

Method Summary

Modifier and Type	Method	Description
static SignalExternalWorkflowExecutionFailedEventAttributes.Builder	builder()
SignalExternalWorkflowExecutionFailedCause	cause()	The cause of the failure.
String	causeAsString()	The cause of the failure.
String	control()	The data attached to the event that the decider can use in subsequent workflow tasks.
Long	decisionTaskCompletedEventId()	The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	initiatedEventId()	The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal.
String	runId()	The runId of the external workflow execution that the signal was being delivered to.
List<SdkField<?>>	sdkFields()
static Class<? extends SignalExternalWorkflowExecutionFailedEventAttributes.Builder>	serializableBuilderClass()
SignalExternalWorkflowExecutionFailedEventAttributes.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	workflowId()	The workflowId of the external workflow execution that the signal was being delivered to.

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

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:

SignalExternalWorkflowExecutionFailedCause

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:

SignalExternalWorkflowExecutionFailedCause

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

Specified by:

toBuilder in interface ToCopyableBuilder<SignalExternalWorkflowExecutionFailedEventAttributes.Builder,SignalExternalWorkflowExecutionFailedEventAttributes>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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