com.amazonaws.services.simpleworkflow.model.WorkflowExecutionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* 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;
/**
*
* The configuration settings for a workflow execution including timeout
* values, tasklist etc. These configuration settings are determined from
* the defaults specified when registering the workflow type and those
* specified when starting the workflow execution.
*
*/
public class WorkflowExecutionConfiguration implements Serializable {
/**
* The maximum duration allowed for decision tasks for this workflow
* execution. The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*
* Constraints:
* Length: 1 - 8
*/
private String taskStartToCloseTimeout;
/**
* The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*
* Constraints:
* Length: 1 - 8
*/
private String executionStartToCloseTimeout;
/**
* The task list used for the decision tasks generated for this workflow
* execution.
*/
private TaskList taskList;
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*/
private String childPolicy;
/**
* The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*
* Constraints:
* Length: 1 - 8
*
* @return The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*/
public String getTaskStartToCloseTimeout() {
return taskStartToCloseTimeout;
}
/**
* The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*
* Constraints:
* Length: 1 - 8
*
* @param taskStartToCloseTimeout The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*/
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout) {
this.taskStartToCloseTimeout = taskStartToCloseTimeout;
}
/**
* The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 8
*
* @param taskStartToCloseTimeout The maximum duration allowed for decision tasks for this workflow
* execution.
The valid values are integers greater than or equal to
* 0. An integer value can be used to specify the duration
* in seconds while NONE can be used to specify unlimited
* duration.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public WorkflowExecutionConfiguration withTaskStartToCloseTimeout(String taskStartToCloseTimeout) {
this.taskStartToCloseTimeout = taskStartToCloseTimeout;
return this;
}
/**
* The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*
* Constraints:
* Length: 1 - 8
*
* @return The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*/
public String getExecutionStartToCloseTimeout() {
return executionStartToCloseTimeout;
}
/**
* The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*
* Constraints:
* Length: 1 - 8
*
* @param executionStartToCloseTimeout The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*/
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout) {
this.executionStartToCloseTimeout = executionStartToCloseTimeout;
}
/**
* The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 8
*
* @param executionStartToCloseTimeout The total duration for this workflow execution.
The valid values
* are integers greater than or equal to 0. An integer value
* can be used to specify the duration in seconds while NONE
* can be used to specify unlimited duration.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public WorkflowExecutionConfiguration withExecutionStartToCloseTimeout(String executionStartToCloseTimeout) {
this.executionStartToCloseTimeout = executionStartToCloseTimeout;
return this;
}
/**
* The task list used for the decision tasks generated for this workflow
* execution.
*
* @return The task list used for the decision tasks generated for this workflow
* execution.
*/
public TaskList getTaskList() {
return taskList;
}
/**
* The task list used for the decision tasks generated for this workflow
* execution.
*
* @param taskList The task list used for the decision tasks generated for this workflow
* execution.
*/
public void setTaskList(TaskList taskList) {
this.taskList = taskList;
}
/**
* The task list used for the decision tasks generated for this workflow
* execution.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param taskList The task list used for the decision tasks generated for this workflow
* execution.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public WorkflowExecutionConfiguration withTaskList(TaskList taskList) {
this.taskList = taskList;
return this;
}
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @return The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* @see ChildPolicy
*/
public String getChildPolicy() {
return childPolicy;
}
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* @see ChildPolicy
*/
public void setChildPolicy(String childPolicy) {
this.childPolicy = childPolicy;
}
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ChildPolicy
*/
public WorkflowExecutionConfiguration withChildPolicy(String childPolicy) {
this.childPolicy = childPolicy;
return this;
}
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* @see ChildPolicy
*/
public void setChildPolicy(ChildPolicy childPolicy) {
this.childPolicy = childPolicy.toString();
}
/**
* The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
*
* @param childPolicy The policy to use for the child workflow executions if this workflow
* execution is terminated, by calling the
* TerminateWorkflowExecution action explicitly or due to an
* expired timeout. The supported child policies are:
* - TERMINATE: the child executions will be terminated.
* - REQUEST_CANCEL: a request to cancel will be attempted for
* each child execution by recording a
*
WorkflowExecutionCancelRequested event in its history. It
* is up to the decider to take appropriate actions when it receives an
* execution history with this event. - ABANDON: no action
* will be taken. The child executions will continue to run.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see ChildPolicy
*/
public WorkflowExecutionConfiguration 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 (getTaskStartToCloseTimeout() != null) sb.append("TaskStartToCloseTimeout: " + getTaskStartToCloseTimeout() + ",");
if (getExecutionStartToCloseTimeout() != null) sb.append("ExecutionStartToCloseTimeout: " + getExecutionStartToCloseTimeout() + ",");
if (getTaskList() != null) sb.append("TaskList: " + getTaskList() + ",");
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 + ((getTaskStartToCloseTimeout() == null) ? 0 : getTaskStartToCloseTimeout().hashCode());
hashCode = prime * hashCode + ((getExecutionStartToCloseTimeout() == null) ? 0 : getExecutionStartToCloseTimeout().hashCode());
hashCode = prime * hashCode + ((getTaskList() == null) ? 0 : getTaskList().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 WorkflowExecutionConfiguration == false) return false;
WorkflowExecutionConfiguration other = (WorkflowExecutionConfiguration)obj;
if (other.getTaskStartToCloseTimeout() == null ^ this.getTaskStartToCloseTimeout() == null) return false;
if (other.getTaskStartToCloseTimeout() != null && other.getTaskStartToCloseTimeout().equals(this.getTaskStartToCloseTimeout()) == 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.getTaskList() == null ^ this.getTaskList() == null) return false;
if (other.getTaskList() != null && other.getTaskList().equals(this.getTaskList()) == 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;
}
}