software.amazon.awssdk.services.swf.model

Class WorkflowExecutionCancelRequestedEventAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.WorkflowExecutionCancelRequestedEventAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkflowExecutionCancelRequestedEventAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>

Provides the details of the WorkflowExecutionCancelRequested event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkflowExecutionCancelRequestedEventAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static WorkflowExecutionCancelRequestedEventAttributes.Builder	builder()
WorkflowExecutionCancelRequestedCause	cause() If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.
String	causeAsString() If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Long	externalInitiatedEventId() The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution.
WorkflowExecution	externalWorkflowExecution() The external workflow execution for which the cancellation was requested.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends WorkflowExecutionCancelRequestedEventAttributes.Builder>	serializableBuilderClass()
WorkflowExecutionCancelRequestedEventAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

externalWorkflowExecution

public final WorkflowExecution externalWorkflowExecution()

The external workflow execution for which the cancellation was requested.

Returns:

The external workflow execution for which the cancellation was requested.

externalInitiatedEventId

public final Long externalInitiatedEventId()

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. 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 RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

cause

public final WorkflowExecutionCancelRequestedCause cause()

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

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

Returns:

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

See Also:

WorkflowExecutionCancelRequestedCause

causeAsString

public final String causeAsString()

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

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

Returns:

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

See Also:

WorkflowExecutionCancelRequestedCause

toBuilder

public WorkflowExecutionCancelRequestedEventAttributes.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<WorkflowExecutionCancelRequestedEventAttributes.Builder,WorkflowExecutionCancelRequestedEventAttributes>

Returns:

a builder for type T

builder

public static WorkflowExecutionCancelRequestedEventAttributes.Builder builder()

serializableBuilderClass

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