com.amazonaws.services.simplesystemsmanagement.model.SendAutomationSignalRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm 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.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SendAutomationSignalRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique identifier for an existing Automation execution that you want to send the signal to.
*
*/
private String automationExecutionId;
/**
*
* The type of signal to send to an Automation execution.
*
*/
private String signalType;
/**
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
*
* For Approve and Reject signal types, the payload is an optional comment that you can
* send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation step to
* start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
*/
private java.util.Map> payload;
/**
*
* The unique identifier for an existing Automation execution that you want to send the signal to.
*
*
* @param automationExecutionId
* The unique identifier for an existing Automation execution that you want to send the signal to.
*/
public void setAutomationExecutionId(String automationExecutionId) {
this.automationExecutionId = automationExecutionId;
}
/**
*
* The unique identifier for an existing Automation execution that you want to send the signal to.
*
*
* @return The unique identifier for an existing Automation execution that you want to send the signal to.
*/
public String getAutomationExecutionId() {
return this.automationExecutionId;
}
/**
*
* The unique identifier for an existing Automation execution that you want to send the signal to.
*
*
* @param automationExecutionId
* The unique identifier for an existing Automation execution that you want to send the signal to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendAutomationSignalRequest withAutomationExecutionId(String automationExecutionId) {
setAutomationExecutionId(automationExecutionId);
return this;
}
/**
*
* The type of signal to send to an Automation execution.
*
*
* @param signalType
* The type of signal to send to an Automation execution.
* @see SignalType
*/
public void setSignalType(String signalType) {
this.signalType = signalType;
}
/**
*
* The type of signal to send to an Automation execution.
*
*
* @return The type of signal to send to an Automation execution.
* @see SignalType
*/
public String getSignalType() {
return this.signalType;
}
/**
*
* The type of signal to send to an Automation execution.
*
*
* @param signalType
* The type of signal to send to an Automation execution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SignalType
*/
public SendAutomationSignalRequest withSignalType(String signalType) {
setSignalType(signalType);
return this;
}
/**
*
* The type of signal to send to an Automation execution.
*
*
* @param signalType
* The type of signal to send to an Automation execution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SignalType
*/
public SendAutomationSignalRequest withSignalType(SignalType signalType) {
this.signalType = signalType.toString();
return this;
}
/**
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
*
* For Approve and Reject signal types, the payload is an optional comment that you can
* send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation step to
* start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
*
* @return The data sent with the signal. The data schema depends on the type of signal used in the request.
*
* For Approve and Reject signal types, the payload is an optional comment that
* you can send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation
* step to start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For
* example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*/
public java.util.Map> getPayload() {
return payload;
}
/**
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
*
* For Approve and Reject signal types, the payload is an optional comment that you can
* send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation step to
* start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
*
* @param payload
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
* For Approve and Reject signal types, the payload is an optional comment that you
* can send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation
* step to start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For
* example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*/
public void setPayload(java.util.Map> payload) {
this.payload = payload;
}
/**
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
*
* For Approve and Reject signal types, the payload is an optional comment that you can
* send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation step to
* start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
*
* @param payload
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
* For Approve and Reject signal types, the payload is an optional comment that you
* can send with the signal type. For example:
*
*
* Comment="Looks good"
*
*
* For StartStep and Resume signal types, you must send the name of the Automation
* step to start or resume as the payload. For example:
*
*
* StepName="step1"
*
*
* For the StopStep signal type, you must send the step execution ID as the payload. For
* example:
*
*
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendAutomationSignalRequest withPayload(java.util.Map> payload) {
setPayload(payload);
return this;
}
/**
* Add a single Payload entry
*
* @see SendAutomationSignalRequest#withPayload
* @returns a reference to this object so that method calls can be chained together.
*/
public SendAutomationSignalRequest addPayloadEntry(String key, java.util.List value) {
if (null == this.payload) {
this.payload = new java.util.HashMap>();
}
if (this.payload.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.payload.put(key, value);
return this;
}
/**
* Removes all the entries added into Payload.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SendAutomationSignalRequest clearPayloadEntries() {
this.payload = null;
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 (getAutomationExecutionId() != null)
sb.append("AutomationExecutionId: ").append(getAutomationExecutionId()).append(",");
if (getSignalType() != null)
sb.append("SignalType: ").append(getSignalType()).append(",");
if (getPayload() != null)
sb.append("Payload: ").append(getPayload());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SendAutomationSignalRequest == false)
return false;
SendAutomationSignalRequest other = (SendAutomationSignalRequest) obj;
if (other.getAutomationExecutionId() == null ^ this.getAutomationExecutionId() == null)
return false;
if (other.getAutomationExecutionId() != null && other.getAutomationExecutionId().equals(this.getAutomationExecutionId()) == false)
return false;
if (other.getSignalType() == null ^ this.getSignalType() == null)
return false;
if (other.getSignalType() != null && other.getSignalType().equals(this.getSignalType()) == false)
return false;
if (other.getPayload() == null ^ this.getPayload() == null)
return false;
if (other.getPayload() != null && other.getPayload().equals(this.getPayload()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAutomationExecutionId() == null) ? 0 : getAutomationExecutionId().hashCode());
hashCode = prime * hashCode + ((getSignalType() == null) ? 0 : getSignalType().hashCode());
hashCode = prime * hashCode + ((getPayload() == null) ? 0 : getPayload().hashCode());
return hashCode;
}
@Override
public SendAutomationSignalRequest clone() {
return (SendAutomationSignalRequest) super.clone();
}
}