com.amazonaws.services.simpleworkflow.model.StartWorkflowExecutionRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.simpleworkflow.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#startWorkflowExecution(StartWorkflowExecutionRequest) StartWorkflowExecution operation}.
*
* Starts an execution of the workflow type in the specified domain
* using the provided workflowId and input data.
*
*
* This action returns the newly started workflow execution.
*
*
* Access Control
*
*
* You can use IAM policies to control this action's access to Amazon SWF
* resources as follows:
*
*
*
* - Use a
Resource element with the domain name to limit
* the action to only specified domains.
* - Use an
Action element to allow or deny permission to
* call this action.
* - Constrain the following parameters by using a
*
Condition element with the appropriate keys.
*
* -
tagList.member.0 : The key is
* swf:tagList.member.0 .
* -
tagList.member.1 : The key is
* swf:tagList.member.1 .
* -
tagList.member.2 : The key is
* swf:tagList.member.2 .
* -
tagList.member.3 : The key is
* swf:tagList.member.3 .
* -
tagList.member.4 : The key is
* swf:tagList.member.4 .
* -
taskList : String constraint. The key is
* swf:taskList.name .
* -
name : String constraint. The key is
* swf:workflowType.name .
* -
version : String constraint. The key is
* swf:workflowType.version .
*
*
*
*
*
*
* If the caller does not have sufficient permissions to invoke the
* action, or the parameter values fall outside the specified
* constraints, the action fails by throwing
* OperationNotPermitted . For details and example IAM
* policies, see
* Using IAM to Manage Access to Amazon SWF Workflows
* .
*
*
* @see com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#startWorkflowExecution(StartWorkflowExecutionRequest)
*/
public class StartWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the domain in which the workflow execution is created.
*
* Constraints:
* Length: 1 - 256
*/
private String domain;
/**
* The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* Constraints:
* Length: 1 - 256
*/
private String workflowId;
/**
* The type of the workflow to start.
*/
private WorkflowType workflowType;
/**
* The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*/
private TaskList taskList;
/**
* The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*
* Constraints:
* Length: 0 - 32768
*/
private String input;
/**
* The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*
* Constraints:
* Length: 0 - 8
*/
private String executionStartToCloseTimeout;
/**
* The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* Constraints:
* Length: 0 - 5
*/
private com.amazonaws.internal.ListWithAutoConstructFlag tagList;
/**
* Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType. 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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*
* Constraints:
* Length: 0 - 8
*/
private String taskStartToCloseTimeout;
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*/
private String childPolicy;
/**
* The name of the domain in which the workflow execution is created.
*
* Constraints:
* Length: 1 - 256
*
* @return The name of the domain in which the workflow execution is created.
*/
public String getDomain() {
return domain;
}
/**
* The name of the domain in which the workflow execution is created.
*
* Constraints:
* Length: 1 - 256
*
* @param domain The name of the domain in which the workflow execution is created.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
* The name of the domain in which the workflow execution is created.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 256
*
* @param domain The name of the domain in which the workflow execution is created.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withDomain(String domain) {
this.domain = domain;
return this;
}
/**
* The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* Constraints:
* Length: 1 - 256
*
* @return The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*/
public String getWorkflowId() {
return workflowId;
}
/**
* The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* Constraints:
* Length: 1 - 256
*
* @param workflowId The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*/
public void setWorkflowId(String workflowId) {
this.workflowId = workflowId;
}
/**
* The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 256
*
* @param workflowId The user defined identifier associated with the workflow execution.
* You can use this to associate a custom identifier with the workflow
* execution. You may specify the same identifier if a workflow execution
* is logically a restart of a previous execution. You cannot have
* two open workflow executions with the same workflowId at
* the same time.
The specified string must not start or end with
* whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withWorkflowId(String workflowId) {
this.workflowId = workflowId;
return this;
}
/**
* The type of the workflow to start.
*
* @return The type of the workflow to start.
*/
public WorkflowType getWorkflowType() {
return workflowType;
}
/**
* The type of the workflow to start.
*
* @param workflowType The type of the workflow to start.
*/
public void setWorkflowType(WorkflowType workflowType) {
this.workflowType = workflowType;
}
/**
* The type of the workflow to start.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param workflowType The type of the workflow to start.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withWorkflowType(WorkflowType workflowType) {
this.workflowType = workflowType;
return this;
}
/**
* The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* @return The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*/
public TaskList getTaskList() {
return taskList;
}
/**
* The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* @param taskList The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*/
public void setTaskList(TaskList taskList) {
this.taskList = taskList;
}
/**
* The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param taskList The task list to use for the decision tasks generated for this
* workflow execution. This overrides the defaultTaskList
* specified when registering the workflow type. A task list for
* this workflow execution must be specified either as a default for the
* workflow type or through this parameter. If neither this parameter is
* set nor a default task list was specified at registration time then a
* fault will be returned.
The specified string must not start
* or end with whitespace. It must not contain a : (colon),
* / (slash), | (vertical bar), or any control
* characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
* contain the literal string "arn".
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withTaskList(TaskList taskList) {
this.taskList = taskList;
return this;
}
/**
* The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*
* Constraints:
* Length: 0 - 32768
*
* @return The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*/
public String getInput() {
return input;
}
/**
* The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*
* Constraints:
* Length: 0 - 32768
*
* @param input The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*/
public void setInput(String input) {
this.input = input;
}
/**
* The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 32768
*
* @param input The input for the workflow execution. This is a free form string which
* should be meaningful to the workflow you are starting. This
* input is made available to the new workflow execution in
* the WorkflowExecutionStarted history event.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withInput(String input) {
this.input = input;
return this;
}
/**
* The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*
* Constraints:
* Length: 0 - 8
*
* @return The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*/
public String getExecutionStartToCloseTimeout() {
return executionStartToCloseTimeout;
}
/**
* The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*
* Constraints:
* Length: 0 - 8
*
* @param executionStartToCloseTimeout The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*/
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout) {
this.executionStartToCloseTimeout = executionStartToCloseTimeout;
}
/**
* The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 8
*
* @param executionStartToCloseTimeout The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
The duration is specified in seconds. The valid
* values are integers greater than or equal to 0. Exceeding this limit
* will cause the workflow execution to time out. Unlike some of the
* other timeout parameters in Amazon SWF, you cannot specify a value of
* "NONE" for this timeout; there is a one-year max limit on the time
* that a workflow execution can run. An execution start-to-close
* timeout must be specified either through this parameter or as a
* default when the workflow type is registered. If neither this
* parameter nor a default execution start-to-close timeout is specified,
* a fault is returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withExecutionStartToCloseTimeout(String executionStartToCloseTimeout) {
this.executionStartToCloseTimeout = executionStartToCloseTimeout;
return this;
}
/**
* The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* Constraints:
* Length: 0 - 5
*
* @return The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*/
public java.util.List getTagList() {
if (tagList == null) {
tagList = new com.amazonaws.internal.ListWithAutoConstructFlag();
tagList.setAutoConstruct(true);
}
return tagList;
}
/**
* The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* Constraints:
* Length: 0 - 5
*
* @param tagList The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*/
public void setTagList(java.util.Collection tagList) {
if (tagList == null) {
this.tagList = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag tagListCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(tagList.size());
tagListCopy.addAll(tagList);
this.tagList = tagListCopy;
}
/**
* The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 5
*
* @param tagList The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withTagList(String... tagList) {
if (getTagList() == null) setTagList(new java.util.ArrayList(tagList.length));
for (String value : tagList) {
getTagList().add(value);
}
return this;
}
/**
* The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 5
*
* @param tagList The list of tags to associate with the workflow execution. You can
* specify a maximum of 5 tags. You can list workflow executions with a
* specific tag by calling ListOpenWorkflowExecutions or
* ListClosedWorkflowExecutions and specifying a TagFilter.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withTagList(java.util.Collection tagList) {
if (tagList == null) {
this.tagList = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag tagListCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(tagList.size());
tagListCopy.addAll(tagList);
this.tagList = tagListCopy;
}
return this;
}
/**
* Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType. 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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*
* Constraints:
* Length: 0 - 8
*
* @return Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType.
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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*/
public String getTaskStartToCloseTimeout() {
return taskStartToCloseTimeout;
}
/**
* Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType.
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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*
* Constraints:
* Length: 0 - 8
*
* @param taskStartToCloseTimeout Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType.
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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*/
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout) {
this.taskStartToCloseTimeout = taskStartToCloseTimeout;
}
/**
* Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType.
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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 8
*
* @param taskStartToCloseTimeout Specifies the maximum duration of decision tasks for this workflow
* execution. This parameter overrides the
* defaultTaskStartToCloseTimout specified when registering
* the workflow type using RegisterWorkflowType.
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. A
* task start-to-close timeout for this workflow execution must be
* specified either as a default for the workflow type or through this
* parameter. If neither this parameter is set nor a default task
* start-to-close timeout was specified at registration time then a fault
* will be returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public StartWorkflowExecutionRequest withTaskStartToCloseTimeout(String taskStartToCloseTimeout) {
this.taskStartToCloseTimeout = taskStartToCloseTimeout;
return this;
}
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @return If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* @see ChildPolicy
*/
public String getChildPolicy() {
return childPolicy;
}
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* @see ChildPolicy
*/
public void setChildPolicy(String childPolicy) {
this.childPolicy = childPolicy;
}
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ChildPolicy
*/
public StartWorkflowExecutionRequest withChildPolicy(String childPolicy) {
this.childPolicy = childPolicy;
return this;
}
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* @see ChildPolicy
*/
public void setChildPolicy(ChildPolicy childPolicy) {
this.childPolicy = childPolicy.toString();
}
/**
* If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy If set, specifies the policy to use for the child workflow executions
* of this workflow execution if it is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. This policy overrides the default child policy
* specified when registering the workflow type using
* RegisterWorkflowType. 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.
* A child policy for this workflow execution must be specified
* either as a default for the workflow type or through this parameter.
* If neither this parameter is set nor a default child policy was
* specified at registration time then a fault will be returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ChildPolicy
*/
public StartWorkflowExecutionRequest withChildPolicy(ChildPolicy childPolicy) {
this.childPolicy = childPolicy.toString();
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDomain() != null) sb.append("Domain: " + getDomain() + ",");
if (getWorkflowId() != null) sb.append("WorkflowId: " + getWorkflowId() + ",");
if (getWorkflowType() != null) sb.append("WorkflowType: " + getWorkflowType() + ",");
if (getTaskList() != null) sb.append("TaskList: " + getTaskList() + ",");
if (getInput() != null) sb.append("Input: " + getInput() + ",");
if (getExecutionStartToCloseTimeout() != null) sb.append("ExecutionStartToCloseTimeout: " + getExecutionStartToCloseTimeout() + ",");
if (getTagList() != null) sb.append("TagList: " + getTagList() + ",");
if (getTaskStartToCloseTimeout() != null) sb.append("TaskStartToCloseTimeout: " + getTaskStartToCloseTimeout() + ",");
if (getChildPolicy() != null) sb.append("ChildPolicy: " + getChildPolicy() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getWorkflowId() == null) ? 0 : getWorkflowId().hashCode());
hashCode = prime * hashCode + ((getWorkflowType() == null) ? 0 : getWorkflowType().hashCode());
hashCode = prime * hashCode + ((getTaskList() == null) ? 0 : getTaskList().hashCode());
hashCode = prime * hashCode + ((getInput() == null) ? 0 : getInput().hashCode());
hashCode = prime * hashCode + ((getExecutionStartToCloseTimeout() == null) ? 0 : getExecutionStartToCloseTimeout().hashCode());
hashCode = prime * hashCode + ((getTagList() == null) ? 0 : getTagList().hashCode());
hashCode = prime * hashCode + ((getTaskStartToCloseTimeout() == null) ? 0 : getTaskStartToCloseTimeout().hashCode());
hashCode = prime * hashCode + ((getChildPolicy() == null) ? 0 : getChildPolicy().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof StartWorkflowExecutionRequest == false) return false;
StartWorkflowExecutionRequest other = (StartWorkflowExecutionRequest)obj;
if (other.getDomain() == null ^ this.getDomain() == null) return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false) return false;
if (other.getWorkflowId() == null ^ this.getWorkflowId() == null) return false;
if (other.getWorkflowId() != null && other.getWorkflowId().equals(this.getWorkflowId()) == false) return false;
if (other.getWorkflowType() == null ^ this.getWorkflowType() == null) return false;
if (other.getWorkflowType() != null && other.getWorkflowType().equals(this.getWorkflowType()) == false) return false;
if (other.getTaskList() == null ^ this.getTaskList() == null) return false;
if (other.getTaskList() != null && other.getTaskList().equals(this.getTaskList()) == false) return false;
if (other.getInput() == null ^ this.getInput() == null) return false;
if (other.getInput() != null && other.getInput().equals(this.getInput()) == false) return false;
if (other.getExecutionStartToCloseTimeout() == null ^ this.getExecutionStartToCloseTimeout() == null) return false;
if (other.getExecutionStartToCloseTimeout() != null && other.getExecutionStartToCloseTimeout().equals(this.getExecutionStartToCloseTimeout()) == false) return false;
if (other.getTagList() == null ^ this.getTagList() == null) return false;
if (other.getTagList() != null && other.getTagList().equals(this.getTagList()) == false) return false;
if (other.getTaskStartToCloseTimeout() == null ^ this.getTaskStartToCloseTimeout() == null) return false;
if (other.getTaskStartToCloseTimeout() != null && other.getTaskStartToCloseTimeout().equals(this.getTaskStartToCloseTimeout()) == false) return false;
if (other.getChildPolicy() == null ^ this.getChildPolicy() == null) return false;
if (other.getChildPolicy() != null && other.getChildPolicy().equals(this.getChildPolicy()) == false) return false;
return true;
}
}