/* * Copyright 2018-2023 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"
*
* 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"
*
* 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:
*
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
* For
*
* For
*
* For the
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*/
public java.util.MapApprove
and Reject
signal types, the payload is an optional comment that you can
* send with the signal type. For example:
* Comment="Looks good"
* 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"
* StopStep
signal type, you must send the step execution ID as the payload. For example:
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
* 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:
*
*
* The data sent with the signal. The data schema depends on the type of signal used in the request.
*
* For
*
* For
*
* For the
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*/
public void setPayload(java.util.MapApprove
and Reject
signal types, the payload is an optional comment that you can
* send with the signal type. For example:
* Comment="Looks good"
* 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"
* StopStep
signal type, you must send the step execution ID as the payload. For example:
* StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"
*
* 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