software.amazon.awssdk.services.swf.model

Class SignalExternalWorkflowExecutionFailedEventAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.SignalExternalWorkflowExecutionFailedEventAttributes

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<SignalExternalWorkflowExecutionFailedEventAttributes.Builder,SignalExternalWorkflowExecutionFailedEventAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public class SignalExternalWorkflowExecutionFailedEventAttributes
extends Object
implements StructuredPojo, ToCopyableBuilder<SignalExternalWorkflowExecutionFailedEventAttributes.Builder,SignalExternalWorkflowExecutionFailedEventAttributes>

Provides the details of the SignalExternalWorkflowExecutionFailed event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SignalExternalWorkflowExecutionFailedEventAttributes.Builder

Method Summary

Modifier and Type	Method and 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)
<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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	runId() The runId of the external workflow execution that the signal was being delivered to.
static Class<? extends SignalExternalWorkflowExecutionFailedEventAttributes.Builder>	serializableBuilderClass()
SignalExternalWorkflowExecutionFailedEventAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	workflowId() The workflowId of the external workflow execution that the signal was being delivered to.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

workflowId

public 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 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 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 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 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 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.