public class RegisterWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RegisterWorkflowTypeRequest() |
Modifier and Type | Method and 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.
|
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
public void setDomain(String domain)
The name of the domain in which to register the workflow type.
domain
- The name of the domain in which to register the workflow type.public String getDomain()
The name of the domain in which to register the workflow type.
public RegisterWorkflowTypeRequest withDomain(String domain)
The name of the domain in which to register the workflow type.
domain
- The name of the domain in which to register the workflow type.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.
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.
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.
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.
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.
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.
public void setVersion(String version)
The version 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.
version
- The version 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.
public String getVersion()
The version 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.
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.
public RegisterWorkflowTypeRequest withVersion(String version)
The version 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.
version
- The version 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.
public void setDescription(String description)
Textual description of the workflow type.
description
- Textual description of the workflow type.public String getDescription()
Textual description of the workflow type.
public RegisterWorkflowTypeRequest withDescription(String description)
Textual description of the workflow type.
description
- Textual description of the workflow type.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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.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.
StartChildWorkflowExecution
decision.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.
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.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) to
Integer.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.
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) to
Integer.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.
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) to
Integer.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.
Integer.MIN_VALUE
(-2147483648) to
Integer.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.
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) to
Integer.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.
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) to
Integer.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.
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.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:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when
it receives an execution history with this event.ChildPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.StartChildWorkflowExecution
decision.
The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when
it receives an execution history with this event.ChildPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.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:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when
it receives an execution history with this event.ChildPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.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:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when
it receives an execution history with this event.ChildPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.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:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when
it receives an execution history with this event.ChildPolicy
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
and
ContinueAsNewWorkflowExecution
decision.
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
and
ContinueAsNewWorkflowExecution
decision.
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
and
ContinueAsNewWorkflowExecution
decision.
This default can be overridden when starting a workflow execution
using the StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
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
and
ContinueAsNewWorkflowExecution
decision.
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
and
ContinueAsNewWorkflowExecution
decision.
public String toString()
toString
in class Object
Object.toString()
public RegisterWorkflowTypeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2018. All rights reserved.