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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasPayload() Returns true if the Payload property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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()

Returns true if the Payload property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasPayload() to see if a value was sent in this field.

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>

Specified by:

toBuilder in class SsmRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.