com.amazonaws.services.simpleworkflow.model

Class WorkflowExecutionTerminatedEventAttributes

java.lang.Object

com.amazonaws.services.simpleworkflow.model.WorkflowExecutionTerminatedEventAttributes

All Implemented Interfaces:

Serializable, Cloneable

public class WorkflowExecutionTerminatedEventAttributes
extends Object
implements Serializable, Cloneable

Provides details of the WorkflowExecutionTerminated event.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowExecutionTerminatedEventAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
WorkflowExecutionTerminatedEventAttributes	clone()
boolean	equals(Object obj)
String	getCause() If set, indicates that the workflow execution was automatically terminated, and specifies the cause.
String	getChildPolicy() The policy used for the child workflow executions of this workflow execution.
String	getDetails() The details provided for the termination (if any).
String	getReason() The reason provided for the termination (if any).
int	hashCode()
void	setCause(String cause) If set, indicates that the workflow execution was automatically terminated, and specifies the cause.
void	setCause(WorkflowExecutionTerminatedCause cause) If set, indicates that the workflow execution was automatically terminated, and specifies the cause.
void	setChildPolicy(ChildPolicy childPolicy) The policy used for the child workflow executions of this workflow execution.
void	setChildPolicy(String childPolicy) The policy used for the child workflow executions of this workflow execution.
void	setDetails(String details) The details provided for the termination (if any).
void	setReason(String reason) The reason provided for the termination (if any).
String	toString() Returns a string representation of this object; useful for testing and debugging.
WorkflowExecutionTerminatedEventAttributes	withCause(String cause) If set, indicates that the workflow execution was automatically terminated, and specifies the cause.
WorkflowExecutionTerminatedEventAttributes	withCause(WorkflowExecutionTerminatedCause cause) If set, indicates that the workflow execution was automatically terminated, and specifies the cause.
WorkflowExecutionTerminatedEventAttributes	withChildPolicy(ChildPolicy childPolicy) The policy used for the child workflow executions of this workflow execution.
WorkflowExecutionTerminatedEventAttributes	withChildPolicy(String childPolicy) The policy used for the child workflow executions of this workflow execution.
WorkflowExecutionTerminatedEventAttributes	withDetails(String details) The details provided for the termination (if any).
WorkflowExecutionTerminatedEventAttributes	withReason(String reason) The reason provided for the termination (if any).

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowExecutionTerminatedEventAttributes

public WorkflowExecutionTerminatedEventAttributes()

Method Detail

getReason

public String getReason()

The reason provided for the termination (if any).

Constraints:
Length: 0 - 256

Returns:

The reason provided for the termination (if any).

setReason

public void setReason(String reason)

The reason provided for the termination (if any).

Constraints:
Length: 0 - 256

Parameters:

reason - The reason provided for the termination (if any).

withReason

public WorkflowExecutionTerminatedEventAttributes withReason(String reason)

The reason provided for the termination (if any).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 256

Parameters:

reason - The reason provided for the termination (if any).

Returns:

A reference to this updated object so that method calls can be chained together.

getDetails

public String getDetails()

The details provided for the termination (if any).

Constraints:
Length: 0 - 32768

Returns:

The details provided for the termination (if any).

setDetails

public void setDetails(String details)

The details provided for the termination (if any).

Constraints:
Length: 0 - 32768

Parameters:

details - The details provided for the termination (if any).

withDetails

public WorkflowExecutionTerminatedEventAttributes withDetails(String details)

The details provided for the termination (if any).

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 32768

Parameters:

details - The details provided for the termination (if any).

Returns:

A reference to this updated object so that method calls can be chained together.

getChildPolicy

public String getChildPolicy()

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Returns:

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

See Also:

ChildPolicy

setChildPolicy

public void setChildPolicy(String childPolicy)

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:

childPolicy - The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

See Also:

ChildPolicy

withChildPolicy

public WorkflowExecutionTerminatedEventAttributes withChildPolicy(String childPolicy)

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:

childPolicy - The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChildPolicy

setChildPolicy

public void setChildPolicy(ChildPolicy childPolicy)

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:

childPolicy - The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

See Also:

ChildPolicy

withChildPolicy

public WorkflowExecutionTerminatedEventAttributes withChildPolicy(ChildPolicy childPolicy)

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:

childPolicy - The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

• TERMINATE: the child executions will be terminated.
• REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
• ABANDON: no action will be taken. The child executions will continue to run.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ChildPolicy

getCause

public String getCause()

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

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Returns:

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

See Also:

WorkflowExecutionTerminatedCause

setCause

public void setCause(String cause)

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

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Parameters:

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

See Also:

WorkflowExecutionTerminatedCause

withCause

public WorkflowExecutionTerminatedEventAttributes withCause(String cause)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

WorkflowExecutionTerminatedCause

setCause

public void setCause(WorkflowExecutionTerminatedCause cause)

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

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Parameters:

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

See Also:

WorkflowExecutionTerminatedCause

withCause

public WorkflowExecutionTerminatedEventAttributes withCause(WorkflowExecutionTerminatedCause cause)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: CHILD_POLICY_APPLIED, EVENT_LIMIT_EXCEEDED, OPERATOR_INITIATED

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

WorkflowExecutionTerminatedCause

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public WorkflowExecutionTerminatedEventAttributes clone()

Overrides:

clone in class Object