com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionDecisionAttributes Maven / Gradle / Ivy
Show all versions of aws-java-sdk-simpleworkflow Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the details of the SignalExternalWorkflowExecution decision.
*
*
* Access Control
*
*
* You can use IAM policies to control this decision'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.
*
*
* -
*
* You cannot use an IAM policy to constrain this action's parameters.
*
*
*
*
* If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the
* specified constraints, the action fails. The associated event attribute's cause parameter is set to
* OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to
* Amazon SWF Workflows in the Amazon SWF Developer Guide.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SignalExternalWorkflowExecutionDecisionAttributes implements Serializable, Cloneable, StructuredPojo {
/**
*
* The workflowId of the workflow execution to be signaled.
*
*/
private String workflowId;
/**
*
* The runId of the workflow execution to be signaled.
*
*/
private String runId;
/**
*
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*
*/
private String signalName;
/**
*
* The input data to be provided with the signal. The target workflow execution uses the signal name and input data
* to process the signal.
*
*/
private String input;
/**
*
* The data attached to the event that can be used by the decider in subsequent decision tasks.
*
*/
private String control;
/**
*
* The workflowId of the workflow execution to be signaled.
*
*
* @param workflowId
* The workflowId of the workflow execution to be signaled.
*/
public void setWorkflowId(String workflowId) {
this.workflowId = workflowId;
}
/**
*
* The workflowId of the workflow execution to be signaled.
*
*
* @return The workflowId of the workflow execution to be signaled.
*/
public String getWorkflowId() {
return this.workflowId;
}
/**
*
* The workflowId of the workflow execution to be signaled.
*
*
* @param workflowId
* The workflowId of the workflow execution to be signaled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SignalExternalWorkflowExecutionDecisionAttributes withWorkflowId(String workflowId) {
setWorkflowId(workflowId);
return this;
}
/**
*
* The runId of the workflow execution to be signaled.
*
*
* @param runId
* The runId of the workflow execution to be signaled.
*/
public void setRunId(String runId) {
this.runId = runId;
}
/**
*
* The runId of the workflow execution to be signaled.
*
*
* @return The runId of the workflow execution to be signaled.
*/
public String getRunId() {
return this.runId;
}
/**
*
* The runId of the workflow execution to be signaled.
*
*
* @param runId
* The runId of the workflow execution to be signaled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SignalExternalWorkflowExecutionDecisionAttributes withRunId(String runId) {
setRunId(runId);
return this;
}
/**
*
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*
*
* @param signalName
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*/
public void setSignalName(String signalName) {
this.signalName = signalName;
}
/**
*
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*
*
* @return The name of the signal.The target workflow execution uses the signal name and input to process the
* signal.
*/
public String getSignalName() {
return this.signalName;
}
/**
*
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*
*
* @param signalName
* The name of the signal.The target workflow execution uses the signal name and input to process the signal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SignalExternalWorkflowExecutionDecisionAttributes withSignalName(String signalName) {
setSignalName(signalName);
return this;
}
/**
*
* The input data to be provided with the signal. The target workflow execution uses the signal name and input data
* to process the signal.
*
*
* @param input
* The input data to be provided with the signal. The target workflow execution uses the signal name and
* input data to process the signal.
*/
public void setInput(String input) {
this.input = input;
}
/**
*
* The input data to be provided with the signal. The target workflow execution uses the signal name and input data
* to process the signal.
*
*
* @return The input data to be provided with the signal. The target workflow execution uses the signal name and
* input data to process the signal.
*/
public String getInput() {
return this.input;
}
/**
*
* The input data to be provided with the signal. The target workflow execution uses the signal name and input data
* to process the signal.
*
*
* @param input
* The input data to be provided with the signal. The target workflow execution uses the signal name and
* input data to process the signal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SignalExternalWorkflowExecutionDecisionAttributes withInput(String input) {
setInput(input);
return this;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent decision tasks.
*
*
* @param control
* The data attached to the event that can be used by the decider in subsequent decision tasks.
*/
public void setControl(String control) {
this.control = control;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent decision tasks.
*
*
* @return The data attached to the event that can be used by the decider in subsequent decision tasks.
*/
public String getControl() {
return this.control;
}
/**
*
* The data attached to the event that can be used by the decider in subsequent decision tasks.
*
*
* @param control
* The data attached to the event that can be used by the decider in subsequent decision tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SignalExternalWorkflowExecutionDecisionAttributes withControl(String control) {
setControl(control);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getWorkflowId() != null)
sb.append("WorkflowId: ").append(getWorkflowId()).append(",");
if (getRunId() != null)
sb.append("RunId: ").append(getRunId()).append(",");
if (getSignalName() != null)
sb.append("SignalName: ").append(getSignalName()).append(",");
if (getInput() != null)
sb.append("Input: ").append(getInput()).append(",");
if (getControl() != null)
sb.append("Control: ").append(getControl());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SignalExternalWorkflowExecutionDecisionAttributes == false)
return false;
SignalExternalWorkflowExecutionDecisionAttributes other = (SignalExternalWorkflowExecutionDecisionAttributes) obj;
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.getSignalName() == null ^ this.getSignalName() == null)
return false;
if (other.getSignalName() != null && other.getSignalName().equals(this.getSignalName()) == 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.getControl() == null ^ this.getControl() == null)
return false;
if (other.getControl() != null && other.getControl().equals(this.getControl()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getWorkflowId() == null) ? 0 : getWorkflowId().hashCode());
hashCode = prime * hashCode + ((getRunId() == null) ? 0 : getRunId().hashCode());
hashCode = prime * hashCode + ((getSignalName() == null) ? 0 : getSignalName().hashCode());
hashCode = prime * hashCode + ((getInput() == null) ? 0 : getInput().hashCode());
hashCode = prime * hashCode + ((getControl() == null) ? 0 : getControl().hashCode());
return hashCode;
}
@Override
public SignalExternalWorkflowExecutionDecisionAttributes clone() {
try {
return (SignalExternalWorkflowExecutionDecisionAttributes) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.simpleworkflow.model.transform.SignalExternalWorkflowExecutionDecisionAttributesMarshaller.getInstance().marshall(this,
protocolMarshaller);
}
}