software.amazon.awssdk.services.ssm.model

Class SendAutomationSignalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.SendAutomationSignalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendAutomationSignalRequest
extends SsmRequest
implements ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SendAutomationSignalRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	automationExecutionId() The unique identifier for an existing Automation execution that you want to send the signal to.
static SendAutomationSignalRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPayload() For responses, this returns true if the service returned a value for the Payload property.
Map<String,List<String>>	payload() The data sent with the signal.
List<SdkField<?>>	sdkFields()
static Class<? extends SendAutomationSignalRequest.Builder>	serializableBuilderClass()
SignalType	signalType() The type of signal to send to an Automation execution.
String	signalTypeAsString() The type of signal to send to an Automation execution.
SendAutomationSignalRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

automationExecutionId

public final String automationExecutionId()

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.

signalType

public final SignalType signalType()

The type of signal to send to an Automation execution.

If the service returns an enum value that is not available in the current SDK version, signalType will return SignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

Returns:

The type of signal to send to an Automation execution.

See Also:

SignalType

signalTypeAsString

public final String signalTypeAsString()

The type of signal to send to an Automation execution.

If the service returns an enum value that is not available in the current SDK version, signalType will return SignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

Returns:

The type of signal to send to an Automation execution.

See Also:

SignalType

hasPayload

public final boolean hasPayload()

For responses, this returns true if the service returned a value for the Payload property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

payload

public final 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"

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPayload() method.

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"

toBuilder

public SendAutomationSignalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static SendAutomationSignalRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SendAutomationSignalRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo