@Generated(value="software.amazon.awssdk:codegen") public final class SendAutomationSignalRequest extends SsmRequest implements ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
SendAutomationSignalRequest.Builder |
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.
|
overrideConfiguration
copy
public final String automationExecutionId()
The unique identifier for an existing Automation execution that you want to send the signal to.
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()
.
SignalType
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()
.
SignalType
public final boolean hasPayload()
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.
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 SendAutomationSignalRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SendAutomationSignalRequest.Builder,SendAutomationSignalRequest>
toBuilder
in class SsmRequest
public static SendAutomationSignalRequest.Builder builder()
public static Class<? extends SendAutomationSignalRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.