com.amazonaws.services.simpleworkflow.model.StartWorkflowExecutionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-simpleworkflow Show documentation
/*
* Copyright 2010-2016 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;
/**
*
*/
public class StartWorkflowExecutionRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The name of the domain in which the workflow execution is created.
*
*/
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 quotarnquot.
*
*/
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 quotarnquot.
*
*/
private TaskList taskList;
/**
*
* The task priority to use for this workflow execution. This will override
* any default priority that was assigned when the workflow type was
* registered. If not set, then the default task priority for the workflow
* type 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.
*
*/
private String taskPriority;
/**
*
* 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.
*
*/
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; an integer 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.
*/
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.
*
*/
private java.util.List 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 duration is specified in seconds; an integer greater than or equal to
* 0. The value "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.
*/
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.
*/
private String childPolicy;
/**
*
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
* functions.
*
* In order for this workflow execution to invoke AWS Lambda
* functions, an appropriate IAM role must be specified either as a default
* for the workflow type or through this field.
*/
private String lambdaRole;
/**
*
* The name of the domain in which the workflow execution is created.
*
*
* @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.
*
*
* @return The name of the domain in which the workflow execution is
* created.
*/
public String getDomain() {
return this.domain;
}
/**
*
* The name of the domain in which the workflow execution is created.
*
*
* @param domain
* The name of the domain in which the workflow execution is created.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withDomain(String domain) {
setDomain(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 quotarnquot.
*
*
* @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 quotarnquot.
*/
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 quotarnquot.
*
*
* @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 quotarnquot.
*/
public String getWorkflowId() {
return this.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 quotarnquot.
*
*
* @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 quotarnquot.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withWorkflowId(String workflowId) {
setWorkflowId(workflowId);
return this;
}
/**
*
* 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.
*
*
* @return The type of the workflow to start.
*/
public WorkflowType getWorkflowType() {
return this.workflowType;
}
/**
*
* The type of the workflow to start.
*
*
* @param workflowType
* The type of the workflow to start.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withWorkflowType(
WorkflowType workflowType) {
setWorkflowType(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 quotarnquot.
*
*
* @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 quotarnquot.
*/
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 quotarnquot.
*
*
* @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 quotarnquot.
*/
public TaskList getTaskList() {
return this.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 quotarnquot.
*
*
* @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 quotarnquot.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withTaskList(TaskList taskList) {
setTaskList(taskList);
return this;
}
/**
*
* The task priority to use for this workflow execution. This will override
* any default priority that was assigned when the workflow type was
* registered. If not set, then the default task priority for the workflow
* type 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.
*
*
* @param taskPriority
* The task priority to use for this workflow execution. This will
* override any default priority that was assigned when the workflow
* type was registered. If not set, then the default task priority
* for the workflow type 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 setTaskPriority(String taskPriority) {
this.taskPriority = taskPriority;
}
/**
*
* The task priority to use for this workflow execution. This will override
* any default priority that was assigned when the workflow type was
* registered. If not set, then the default task priority for the workflow
* type 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.
*
*
* @return The task priority to use for this workflow execution. This will
* override any default priority that was assigned when the workflow
* type was registered. If not set, then the default task priority
* for the workflow type 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 getTaskPriority() {
return this.taskPriority;
}
/**
*
* The task priority to use for this workflow execution. This will override
* any default priority that was assigned when the workflow type was
* registered. If not set, then the default task priority for the workflow
* type 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.
*
*
* @param taskPriority
* The task priority to use for this workflow execution. This will
* override any default priority that was assigned when the workflow
* type was registered. If not set, then the default task priority
* for the workflow type 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withTaskPriority(String taskPriority) {
setTaskPriority(taskPriority);
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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withInput(String input) {
setInput(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; an integer 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.
*
* @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; an integer 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; an integer 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 The total duration for this workflow execution. This overrides
* the defaultExecutionStartToCloseTimeout specified when
* registering the workflow type.
*
* The duration is specified in seconds; an integer 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 this.executionStartToCloseTimeout;
}
/**
*
* The total duration for this workflow execution. This overrides the
* defaultExecutionStartToCloseTimeout specified when registering the
* workflow type.
*
*
* The duration is specified in seconds; an integer 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.
*
* @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; an integer 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 Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withExecutionStartToCloseTimeout(
String executionStartToCloseTimeout) {
setExecutionStartToCloseTimeout(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.
*
*
* @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() {
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.
*
*
* @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;
}
this.tagList = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setTagList(java.util.Collection)} or
* {@link #withTagList(java.util.Collection)} if you want to override the
* existing values.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withTagList(String... tagList) {
if (this.tagList == null) {
setTagList(new java.util.ArrayList(tagList.length));
}
for (String ele : tagList) {
this.tagList.add(ele);
}
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.
*
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withTagList(
java.util.Collection tagList) {
setTagList(tagList);
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 duration is specified in seconds; an integer greater than or equal to
* 0. The value "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.
*
* @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 duration is specified in seconds; an integer greater than or
* equal to 0. The value "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 duration is specified in seconds; an integer greater than or equal to
* 0. The value "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 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 duration is specified in seconds; an integer greater than or
* equal to 0. The value "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 this.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 duration is specified in seconds; an integer greater than or equal to
* 0. The value "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.
*
* @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 duration is specified in seconds; an integer greater than or
* equal to 0. The value "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 Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withTaskStartToCloseTimeout(
String taskStartToCloseTimeout) {
setTaskStartToCloseTimeout(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.
*
* @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.
*
* @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 this.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.
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
* @see ChildPolicy
*/
public StartWorkflowExecutionRequest withChildPolicy(String childPolicy) {
setChildPolicy(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.
*
* @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.
*
* @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 Returns a reference to this object so that method calls can be
* chained together.
* @see ChildPolicy
*/
public StartWorkflowExecutionRequest withChildPolicy(ChildPolicy childPolicy) {
setChildPolicy(childPolicy);
return this;
}
/**
*
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
* functions.
*
* In order for this workflow execution to invoke AWS Lambda
* functions, an appropriate IAM role must be specified either as a default
* for the workflow type or through this field.
*
* @param lambdaRole
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS
* Lambda functions. In order for this workflow execution
* to invoke AWS Lambda functions, an appropriate IAM role must be
* specified either as a default for the workflow type or through
* this field.
*/
public void setLambdaRole(String lambdaRole) {
this.lambdaRole = lambdaRole;
}
/**
*
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
* functions.
*
* In order for this workflow execution to invoke AWS Lambda
* functions, an appropriate IAM role must be specified either as a default
* for the workflow type or through this field.
*
* @return The ARN of an IAM role that authorizes Amazon SWF to invoke AWS
* Lambda functions. In order for this workflow execution
* to invoke AWS Lambda functions, an appropriate IAM role must be
* specified either as a default for the workflow type or through
* this field.
*/
public String getLambdaRole() {
return this.lambdaRole;
}
/**
*
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda
* functions.
*
* In order for this workflow execution to invoke AWS Lambda
* functions, an appropriate IAM role must be specified either as a default
* for the workflow type or through this field.
*
* @param lambdaRole
* The ARN of an IAM role that authorizes Amazon SWF to invoke AWS
* Lambda functions. In order for this workflow execution
* to invoke AWS Lambda functions, an appropriate IAM role must be
* specified either as a default for the workflow type or through
* this field.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public StartWorkflowExecutionRequest withLambdaRole(String lambdaRole) {
setLambdaRole(lambdaRole);
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 (getTaskPriority() != null)
sb.append("TaskPriority: " + getTaskPriority() + ",");
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() + ",");
if (getLambdaRole() != null)
sb.append("LambdaRole: " + getLambdaRole());
sb.append("}");
return sb.toString();
}
@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.getTaskPriority() == null ^ this.getTaskPriority() == null)
return false;
if (other.getTaskPriority() != null
&& other.getTaskPriority().equals(this.getTaskPriority()) == 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;
if (other.getLambdaRole() == null ^ this.getLambdaRole() == null)
return false;
if (other.getLambdaRole() != null
&& other.getLambdaRole().equals(this.getLambdaRole()) == false)
return false;
return true;
}
@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
+ ((getTaskPriority() == null) ? 0 : getTaskPriority()
.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());
hashCode = prime * hashCode
+ ((getLambdaRole() == null) ? 0 : getLambdaRole().hashCode());
return hashCode;
}
@Override
public StartWorkflowExecutionRequest clone() {
return (StartWorkflowExecutionRequest) super.clone();
}
}