com.amazonaws.services.simpleworkflow.model.TerminateWorkflowExecutionRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-osgi Show documentation
Show all versions of aws-java-sdk-osgi Show documentation
The AWS SDK for Java with support for OSGi. The AWS SDK for Java provides Java APIs for building software on AWS' cost-effective, scalable, and reliable infrastructure products. The AWS Java SDK allows developers to code against APIs for all of Amazon's infrastructure web services (Amazon S3, Amazon EC2, Amazon SQS, Amazon Relational Database Service, Amazon AutoScaling, etc).
/*
* Copyright 2011-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 TerminateWorkflowExecutionRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* The domain of the workflow execution to terminate.
*
*/
private String domain;
/**
*
* The workflowId of the workflow execution to terminate.
*
*/
private String workflowId;
/**
*
* The runId of the workflow execution to terminate.
*
*/
private String runId;
/**
*
* Optional. A descriptive reason for terminating the workflow
* execution.
*
*/
private String reason;
/**
*
* Optional. Details for terminating the workflow execution.
*
*/
private String details;
/**
*
* If set, specifies the policy to use for the child workflow executions of
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 domain of the workflow execution to terminate.
*
*
* @param domain
* The domain of the workflow execution to terminate.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* The domain of the workflow execution to terminate.
*
*
* @return The domain of the workflow execution to terminate.
*/
public String getDomain() {
return this.domain;
}
/**
*
* The domain of the workflow execution to terminate.
*
*
* @param domain
* The domain of the workflow execution to terminate.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TerminateWorkflowExecutionRequest withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The workflowId of the workflow execution to terminate.
*
*
* @param workflowId
* The workflowId of the workflow execution to terminate.
*/
public void setWorkflowId(String workflowId) {
this.workflowId = workflowId;
}
/**
*
* The workflowId of the workflow execution to terminate.
*
*
* @return The workflowId of the workflow execution to terminate.
*/
public String getWorkflowId() {
return this.workflowId;
}
/**
*
* The workflowId of the workflow execution to terminate.
*
*
* @param workflowId
* The workflowId of the workflow execution to terminate.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TerminateWorkflowExecutionRequest withWorkflowId(String workflowId) {
setWorkflowId(workflowId);
return this;
}
/**
*
* The runId of the workflow execution to terminate.
*
*
* @param runId
* The runId of the workflow execution to terminate.
*/
public void setRunId(String runId) {
this.runId = runId;
}
/**
*
* The runId of the workflow execution to terminate.
*
*
* @return The runId of the workflow execution to terminate.
*/
public String getRunId() {
return this.runId;
}
/**
*
* The runId of the workflow execution to terminate.
*
*
* @param runId
* The runId of the workflow execution to terminate.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TerminateWorkflowExecutionRequest withRunId(String runId) {
setRunId(runId);
return this;
}
/**
*
* Optional. A descriptive reason for terminating the workflow
* execution.
*
*
* @param reason
* Optional.
*/
public void setReason(String reason) {
this.reason = reason;
}
/**
*
* Optional. A descriptive reason for terminating the workflow
* execution.
*
*
* @return Optional.
*/
public String getReason() {
return this.reason;
}
/**
*
* Optional. A descriptive reason for terminating the workflow
* execution.
*
*
* @param reason
* Optional.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TerminateWorkflowExecutionRequest withReason(String reason) {
setReason(reason);
return this;
}
/**
*
* Optional. Details for terminating the workflow execution.
*
*
* @param details
* Optional.
*/
public void setDetails(String details) {
this.details = details;
}
/**
*
* Optional. Details for terminating the workflow execution.
*
*
* @return Optional.
*/
public String getDetails() {
return this.details;
}
/**
*
* Optional. Details for terminating the workflow execution.
*
*
* @param details
* Optional.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public TerminateWorkflowExecutionRequest withDetails(String details) {
setDetails(details);
return this;
}
/**
*
* If set, specifies the policy to use for the child workflow executions of
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 the workflow execution being terminated. This policy
* overrides the child policy specified for the workflow execution at
* registration time or when starting the execution.
*
* 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
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 the workflow execution being terminated. This
* policy overrides the child policy specified for the workflow
* execution at registration time or when starting the
* execution.
*
* 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
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 the workflow execution being terminated. This policy
* overrides the child policy specified for the workflow execution at
* registration time or when starting the execution.
*
* 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 TerminateWorkflowExecutionRequest withChildPolicy(String childPolicy) {
setChildPolicy(childPolicy);
return this;
}
/**
*
* If set, specifies the policy to use for the child workflow executions of
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 the workflow execution being terminated. This policy
* overrides the child policy specified for the workflow execution at
* registration time or when starting the execution.
*
* 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
* the workflow execution being terminated. This policy overrides the child
* policy specified for the workflow execution at registration time or when
* starting the execution.
*
*
* 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 the workflow execution being terminated. This policy
* overrides the child policy specified for the workflow execution at
* registration time or when starting the execution.
*
* 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 TerminateWorkflowExecutionRequest withChildPolicy(
ChildPolicy childPolicy) {
setChildPolicy(childPolicy);
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 (getRunId() != null)
sb.append("RunId: " + getRunId() + ",");
if (getReason() != null)
sb.append("Reason: " + getReason() + ",");
if (getDetails() != null)
sb.append("Details: " + getDetails() + ",");
if (getChildPolicy() != null)
sb.append("ChildPolicy: " + getChildPolicy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TerminateWorkflowExecutionRequest == false)
return false;
TerminateWorkflowExecutionRequest other = (TerminateWorkflowExecutionRequest) 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.getRunId() == null ^ this.getRunId() == null)
return false;
if (other.getRunId() != null
&& other.getRunId().equals(this.getRunId()) == false)
return false;
if (other.getReason() == null ^ this.getReason() == null)
return false;
if (other.getReason() != null
&& other.getReason().equals(this.getReason()) == false)
return false;
if (other.getDetails() == null ^ this.getDetails() == null)
return false;
if (other.getDetails() != null
&& other.getDetails().equals(this.getDetails()) == 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;
}
@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
+ ((getRunId() == null) ? 0 : getRunId().hashCode());
hashCode = prime * hashCode
+ ((getReason() == null) ? 0 : getReason().hashCode());
hashCode = prime * hashCode
+ ((getDetails() == null) ? 0 : getDetails().hashCode());
hashCode = prime
* hashCode
+ ((getChildPolicy() == null) ? 0 : getChildPolicy().hashCode());
return hashCode;
}
@Override
public TerminateWorkflowExecutionRequest clone() {
return (TerminateWorkflowExecutionRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy