Class RegisterWorkflowTypeRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.simpleworkflow.model.RegisterWorkflowTypeRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class RegisterWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description RegisterWorkflowTypeRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RegisterWorkflowTypeRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDefaultChildPolicy()
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.String
getDefaultExecutionStartToCloseTimeout()
If set, specifies the default maximum duration for executions of this workflow type.String
getDefaultLambdaRole()
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.TaskList
getDefaultTaskList()
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.String
getDefaultTaskPriority()
The default task priority to assign to the workflow type.String
getDefaultTaskStartToCloseTimeout()
If set, specifies the default maximum duration of decision tasks for this workflow type.String
getDescription()
Textual description of the workflow type.String
getDomain()
The name of the domain in which to register the workflow type.String
getName()
The name of the workflow type.String
getVersion()
The version of the workflow type.int
hashCode()
void
setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.void
setDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.void
setDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this workflow type.void
setDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.void
setDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.void
setDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type.void
setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for this workflow type.void
setDescription(String description)
Textual description of the workflow type.void
setDomain(String domain)
The name of the domain in which to register the workflow type.void
setName(String name)
The name of the workflow type.void
setVersion(String version)
The version of the workflow type.String
toString()
Returns a string representation of this object; useful for testing and debugging.RegisterWorkflowTypeRequest
withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.RegisterWorkflowTypeRequest
withDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.RegisterWorkflowTypeRequest
withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this workflow type.RegisterWorkflowTypeRequest
withDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.RegisterWorkflowTypeRequest
withDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.RegisterWorkflowTypeRequest
withDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type.RegisterWorkflowTypeRequest
withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for this workflow type.RegisterWorkflowTypeRequest
withDescription(String description)
Textual description of the workflow type.RegisterWorkflowTypeRequest
withDomain(String domain)
The name of the domain in which to register the workflow type.RegisterWorkflowTypeRequest
withName(String name)
The name of the workflow type.RegisterWorkflowTypeRequest
withVersion(String version)
The version of the workflow type.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDomain
public void setDomain(String domain)
The name of the domain in which to register the workflow type.
- Parameters:
domain
- The name of the domain in which to register the workflow type.
-
getDomain
public String getDomain()
The name of the domain in which to register the workflow type.
- Returns:
- The name of the domain in which to register the workflow type.
-
withDomain
public RegisterWorkflowTypeRequest withDomain(String domain)
The name of the domain in which to register the workflow type.
- Parameters:
domain
- The name of the domain in which to register the workflow type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
public void setName(String name)
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
name
- The name of the workflow type.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
getName
public String getName()
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
withName
public RegisterWorkflowTypeRequest withName(String name)
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
name
- The name of the workflow type.The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVersion
public void setVersion(String version)
The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
version
- The version of the workflow type.The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
getVersion
public String getVersion()
The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.
-
withVersion
public RegisterWorkflowTypeRequest withVersion(String version)
The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Parameters:
version
- The version of the workflow type.The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action. The specified string must not start or end with whitespace. It must not contain a
:
(colon),/
(slash),|
(vertical bar), or any control characters ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
Textual description of the workflow type.
- Parameters:
description
- Textual description of the workflow type.
-
getDescription
public String getDescription()
Textual description of the workflow type.
- Returns:
- Textual description of the workflow type.
-
withDescription
public RegisterWorkflowTypeRequest withDescription(String description)
Textual description of the workflow type.
- Parameters:
description
- Textual description of the workflow type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskStartToCloseTimeout
public void setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
- Parameters:
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
-
getDefaultTaskStartToCloseTimeout
public String getDefaultTaskStartToCloseTimeout()
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
- Returns:
- If set, specifies the default maximum duration of decision tasks
for this workflow type. This default can be overridden when
starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
-
withDefaultTaskStartToCloseTimeout
public RegisterWorkflowTypeRequest withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
- Parameters:
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultExecutionStartToCloseTimeout
public void setDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.- Parameters:
defaultExecutionStartToCloseTimeout
- If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action orStartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
-
getDefaultExecutionStartToCloseTimeout
public String getDefaultExecutionStartToCloseTimeout()
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.- Returns:
- If set, specifies the default maximum duration for executions of
this workflow type. You can override this default when starting
an execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.
-
withDefaultExecutionStartToCloseTimeout
public RegisterWorkflowTypeRequest withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.- Parameters:
defaultExecutionStartToCloseTimeout
- If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action orStartChildWorkflowExecution
decision.The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskList
public void setDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.- Parameters:
defaultTaskList
- If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action orStartChildWorkflowExecution
decision.
-
getDefaultTaskList
public TaskList getDefaultTaskList()
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.- Returns:
- If set, specifies the default task list to use for scheduling
decision tasks for executions of this workflow type. This default
is used only if a task list is not provided when starting the
execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.
-
withDefaultTaskList
public RegisterWorkflowTypeRequest withDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision.- Parameters:
defaultTaskList
- If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action orStartChildWorkflowExecution
decision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskPriority
public void setDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Parameters:
defaultTaskPriority
- The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
-
getDefaultTaskPriority
public String getDefaultTaskPriority()
The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Returns:
- The default task priority to assign to the workflow type. If not
assigned, then "0" will be used. Valid values are integers that
range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
-
withDefaultTaskPriority
public RegisterWorkflowTypeRequest withDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Parameters:
defaultTaskPriority
- The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultChildPolicy
public void setDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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.
- Parameters:
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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
-
getDefaultChildPolicy
public String getDefaultChildPolicy()
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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:
- If set, specifies the default policy to use for the child
workflow executions when a workflow execution of this type is
terminated, by calling the TerminateWorkflowExecution
action explicitly or due to an expired timeout. This default can
be overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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
-
withDefaultChildPolicy
public RegisterWorkflowTypeRequest withDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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.
- Parameters:
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
-
setDefaultChildPolicy
public void setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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.
- Parameters:
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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
-
withDefaultChildPolicy
public RegisterWorkflowTypeRequest withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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.
- Parameters:
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
-
setDefaultLambdaRole
public void setDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.- Parameters:
defaultLambdaRole
- The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.
-
getDefaultLambdaRole
public String getDefaultLambdaRole()
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.- Returns:
- The ARN of the default IAM role to use when a workflow execution
of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.
-
withDefaultLambdaRole
public RegisterWorkflowTypeRequest withDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.- Parameters:
defaultLambdaRole
- The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
andContinueAsNewWorkflowExecution
decision.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public RegisterWorkflowTypeRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-