Overview  Package   Class  Index  Help 

Did this page help you?

   Yes   No   Tell us about it...
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.simpleworkflow.model
Class StartChildWorkflowExecutionInitiatedEventAttributes

java.lang.Object
  extended by com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionInitiatedEventAttributes

public class StartChildWorkflowExecutionInitiatedEventAttributes
extends Object

Provides details of the StartChildWorkflowExecutionInitiated event.

Constructor Summary
StartChildWorkflowExecutionInitiatedEventAttributes()
           
 
Method Summary
 boolean equals(Object obj)
           
 String getChildPolicy()
          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
 String getControl()
          Optional data attached to the event that can be used by the decider in subsequent decision tasks.
 Long getDecisionTaskCompletedEventId()
          The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.
 String getExecutionStartToCloseTimeout()
          The maximum duration for the child workflow execution.
 String getInput()
          The inputs provided to the child workflow execution (if any).
 List<String> getTagList()
          The list of tags to associated with the child workflow execution.
 TaskList getTaskList()
          The name of the task list used for the decision tasks of the child workflow execution.
 String getTaskStartToCloseTimeout()
          The maximum duration allowed for the decision tasks for this workflow execution.
 String getWorkflowId()
          The workflowId of the child workflow execution.
 WorkflowType getWorkflowType()
          The type of the child workflow execution.
 int hashCode()
           
 void setChildPolicy(ChildPolicy childPolicy)
          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
 void setChildPolicy(String childPolicy)
          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
 void setControl(String control)
          Optional data attached to the event that can be used by the decider in subsequent decision tasks.
 void setDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId)
          The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.
 void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
          The maximum duration for the child workflow execution.
 void setInput(String input)
          The inputs provided to the child workflow execution (if any).
 void setTagList(Collection<String> tagList)
          The list of tags to associated with the child workflow execution.
 void setTaskList(TaskList taskList)
          The name of the task list used for the decision tasks of the child workflow execution.
 void setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
          The maximum duration allowed for the decision tasks for this workflow execution.
 void setWorkflowId(String workflowId)
          The workflowId of the child workflow execution.
 void setWorkflowType(WorkflowType workflowType)
          The type of the child workflow execution.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 StartChildWorkflowExecutionInitiatedEventAttributes withChildPolicy(ChildPolicy childPolicy)
          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
 StartChildWorkflowExecutionInitiatedEventAttributes withChildPolicy(String childPolicy)
          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
 StartChildWorkflowExecutionInitiatedEventAttributes withControl(String control)
          Optional data attached to the event that can be used by the decider in subsequent decision tasks.
 StartChildWorkflowExecutionInitiatedEventAttributes withDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId)
          The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
          The maximum duration for the child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withInput(String input)
          The inputs provided to the child workflow execution (if any).
 StartChildWorkflowExecutionInitiatedEventAttributes withTagList(Collection<String> tagList)
          The list of tags to associated with the child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withTagList(String... tagList)
          The list of tags to associated with the child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withTaskList(TaskList taskList)
          The name of the task list used for the decision tasks of the child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
          The maximum duration allowed for the decision tasks for this workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withWorkflowId(String workflowId)
          The workflowId of the child workflow execution.
 StartChildWorkflowExecutionInitiatedEventAttributes withWorkflowType(WorkflowType workflowType)
          The type of the child workflow execution.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StartChildWorkflowExecutionInitiatedEventAttributes

public StartChildWorkflowExecutionInitiatedEventAttributes()
Method Detail

getWorkflowId

public String getWorkflowId()
The workflowId of the child workflow execution.

Constraints:
Length: 1 - 256

Returns:
The workflowId of the child workflow execution.

setWorkflowId

public void setWorkflowId(String workflowId)
The workflowId of the child workflow execution.

Constraints:
Length: 1 - 256

Parameters:
workflowId - The workflowId of the child workflow execution.

withWorkflowId

public StartChildWorkflowExecutionInitiatedEventAttributes withWorkflowId(String workflowId)
The workflowId of the child workflow execution.

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

Constraints:
Length: 1 - 256

Parameters:
workflowId - The workflowId of the child workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.

getWorkflowType

public WorkflowType getWorkflowType()
The type of the child workflow execution.

Returns:
The type of the child workflow execution.

setWorkflowType

public void setWorkflowType(WorkflowType workflowType)
The type of the child workflow execution.

Parameters:
workflowType - The type of the child workflow execution.

withWorkflowType

public StartChildWorkflowExecutionInitiatedEventAttributes withWorkflowType(WorkflowType workflowType)
The type of the child workflow execution.

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

Parameters:
workflowType - The type of the child workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.

getControl

public String getControl()
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

Constraints:
Length: 0 - 32768

Returns:
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

setControl

public void setControl(String control)
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

Constraints:
Length: 0 - 32768

Parameters:
control - Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

withControl

public StartChildWorkflowExecutionInitiatedEventAttributes withControl(String control)
Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

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

Constraints:
Length: 0 - 32768

Parameters:
control - Optional data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
Returns:
A reference to this updated object so that method calls can be chained together.

getInput

public String getInput()
The inputs provided to the child workflow execution (if any).

Constraints:
Length: 0 - 32768

Returns:
The inputs provided to the child workflow execution (if any).

setInput

public void setInput(String input)
The inputs provided to the child workflow execution (if any).

Constraints:
Length: 0 - 32768

Parameters:
input - The inputs provided to the child workflow execution (if any).

withInput

public StartChildWorkflowExecutionInitiatedEventAttributes withInput(String input)
The inputs provided to the child workflow execution (if any).

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

Constraints:
Length: 0 - 32768

Parameters:
input - The inputs provided to the child workflow execution (if any).
Returns:
A reference to this updated object so that method calls can be chained together.

getExecutionStartToCloseTimeout

public String getExecutionStartToCloseTimeout()
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Returns:
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

setExecutionStartToCloseTimeout

public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Parameters:
executionStartToCloseTimeout - The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

withExecutionStartToCloseTimeout

public StartChildWorkflowExecutionInitiatedEventAttributes withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

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

Constraints:
Length: 0 - 8

Parameters:
executionStartToCloseTimeout - The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

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

getTaskList

public TaskList getTaskList()
The name of the task list used for the decision tasks of the child workflow execution.

Returns:
The name of the task list used for the decision tasks of the child workflow execution.

setTaskList

public void setTaskList(TaskList taskList)
The name of the task list used for the decision tasks of the child workflow execution.

Parameters:
taskList - The name of the task list used for the decision tasks of the child workflow execution.

withTaskList

public StartChildWorkflowExecutionInitiatedEventAttributes withTaskList(TaskList taskList)
The name of the task list used for the decision tasks of the child workflow execution.

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

Parameters:
taskList - The name of the task list used for the decision tasks of the child workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.

getDecisionTaskCompletedEventId

public Long getDecisionTaskCompletedEventId()
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Returns:
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

setDecisionTaskCompletedEventId

public void setDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId)
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

Parameters:
decisionTaskCompletedEventId - The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

withDecisionTaskCompletedEventId

public StartChildWorkflowExecutionInitiatedEventAttributes withDecisionTaskCompletedEventId(Long decisionTaskCompletedEventId)
The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

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

Parameters:
decisionTaskCompletedEventId - The id of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
Returns:
A reference to this updated object so that method calls can be chained together.

getChildPolicy

public String getChildPolicy()
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Returns:
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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 to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
childPolicy - The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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 StartChildWorkflowExecutionInitiatedEventAttributes withChildPolicy(String childPolicy)
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

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 to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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 to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
childPolicy - The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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 StartChildWorkflowExecutionInitiatedEventAttributes withChildPolicy(ChildPolicy childPolicy)
The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

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 to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

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

getTaskStartToCloseTimeout

public String getTaskStartToCloseTimeout()
The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Returns:
The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

setTaskStartToCloseTimeout

public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

Parameters:
taskStartToCloseTimeout - The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

withTaskStartToCloseTimeout

public StartChildWorkflowExecutionInitiatedEventAttributes withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

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

Constraints:
Length: 0 - 8

Parameters:
taskStartToCloseTimeout - The maximum duration allowed for the decision tasks for this workflow execution.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

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

getTagList

public List<String> getTagList()
The list of tags to associated with the child workflow execution.

Constraints:
Length: 0 - 5

Returns:
The list of tags to associated with the child workflow execution.

setTagList

public void setTagList(Collection<String> tagList)
The list of tags to associated with the child workflow execution.

Constraints:
Length: 0 - 5

Parameters:
tagList - The list of tags to associated with the child workflow execution.

withTagList

public StartChildWorkflowExecutionInitiatedEventAttributes withTagList(String... tagList)
The list of tags to associated with the child workflow execution.

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

Constraints:
Length: 0 - 5

Parameters:
tagList - The list of tags to associated with the child workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.

withTagList

public StartChildWorkflowExecutionInitiatedEventAttributes withTagList(Collection<String> tagList)
The list of tags to associated with the child workflow execution.

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

Constraints:
Length: 0 - 5

Parameters:
tagList - The list of tags to associated with the child workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.

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
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.