com.amazonaws.services.simplesystemsmanagement.model

Class SendAutomationSignalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.SendAutomationSignalRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendAutomationSignalRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendAutomationSignalRequest()

Method Summary

Modifier and Type	Method and Description
SendAutomationSignalRequest	addPayloadEntry(String key, List<String> value) Add a single Payload entry
SendAutomationSignalRequest	clearPayloadEntries() Removes all the entries added into Payload.
SendAutomationSignalRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAutomationExecutionId() The unique identifier for an existing Automation execution that you want to send the signal to.
Map<String,List<String>>	getPayload() The data sent with the signal.
String	getSignalType() The type of signal to send to an Automation execution.
int	hashCode()
void	setAutomationExecutionId(String automationExecutionId) The unique identifier for an existing Automation execution that you want to send the signal to.
void	setPayload(Map<String,List<String>> payload) The data sent with the signal.
void	setSignalType(String signalType) The type of signal to send to an Automation execution.
String	toString() Returns a string representation of this object.
SendAutomationSignalRequest	withAutomationExecutionId(String automationExecutionId) The unique identifier for an existing Automation execution that you want to send the signal to.
SendAutomationSignalRequest	withPayload(Map<String,List<String>> payload) The data sent with the signal.
SendAutomationSignalRequest	withSignalType(SignalType signalType) The type of signal to send to an Automation execution.
SendAutomationSignalRequest	withSignalType(String signalType) The type of signal to send to an Automation execution.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendAutomationSignalRequest

public SendAutomationSignalRequest()

Method Detail

setAutomationExecutionId

public void setAutomationExecutionId(String automationExecutionId)

The unique identifier for an existing Automation execution that you want to send the signal to.

Parameters:

automationExecutionId - The unique identifier for an existing Automation execution that you want to send the signal to.

getAutomationExecutionId

public String getAutomationExecutionId()

The unique identifier for an existing Automation execution that you want to send the signal to.

Returns:

The unique identifier for an existing Automation execution that you want to send the signal to.

withAutomationExecutionId

public SendAutomationSignalRequest withAutomationExecutionId(String automationExecutionId)

The unique identifier for an existing Automation execution that you want to send the signal to.

Parameters:

automationExecutionId - The unique identifier for an existing Automation execution that you want to send the signal to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSignalType

public void setSignalType(String signalType)

The type of signal to send to an Automation execution.

Parameters:

signalType - The type of signal to send to an Automation execution.

See Also:

SignalType

getSignalType

public String getSignalType()

The type of signal to send to an Automation execution.

Returns:

The type of signal to send to an Automation execution.

See Also:

SignalType

withSignalType

public SendAutomationSignalRequest withSignalType(String signalType)

The type of signal to send to an Automation execution.

Parameters:

signalType - The type of signal to send to an Automation execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SignalType

withSignalType

public SendAutomationSignalRequest withSignalType(SignalType signalType)

The type of signal to send to an Automation execution.

Parameters:

signalType - The type of signal to send to an Automation execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SignalType

getPayload

public Map<String,List<String>> getPayload()

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"

Returns:

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"

setPayload

public void setPayload(Map<String,List<String>> 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"

Parameters:

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"

withPayload

public SendAutomationSignalRequest withPayload(Map<String,List<String>> 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"

Parameters:

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"

Returns:

Returns a reference to this object so that method calls can be chained together.

addPayloadEntry

public SendAutomationSignalRequest addPayloadEntry(String key,
                                                   List<String> value)

Add a single Payload entry

See Also:

withPayload(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearPayloadEntries

public SendAutomationSignalRequest clearPayloadEntries()

Removes all the entries added into Payload.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendAutomationSignalRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()