@Generated(value="software.amazon.awssdk:codegen") public final class InputTransformer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InputTransformer.Builder,InputTransformer>
Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.
Modifier and Type | Class and Description |
---|---|
static interface |
InputTransformer.Builder |
Modifier and Type | Method and Description |
---|---|
static InputTransformer.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasInputPathsMap()
For responses, this returns true if the service returned a value for the InputPathsMap property.
|
Map<String,String> |
inputPathsMap()
Map of JSON paths to be extracted from the event.
|
String |
inputTemplate()
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMap to customize the data sent to the target. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends InputTransformer.Builder> |
serializableBuilderClass() |
InputTransformer.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasInputPathsMap()
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.public final Map<String,String> inputPathsMap()
Map of JSON paths to be extracted from the event. You can then insert these in the template in
InputTemplate
to produce the output you want to be sent to the target.
InputPathsMap
is an array key-value pairs, where each value is a valid JSON path. You can have as
many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
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 hasInputPathsMap()
method.
InputTemplate
to produce the output you want to be sent to the target.
InputPathsMap
is an array key-value pairs, where each value is a valid JSON path. You can
have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
public final String inputTemplate()
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMap
to customize the data sent to the target. Enclose each InputPathsMaps
value in brackets: <value> The InputTemplate must be valid JSON.
If InputTemplate
is a JSON object (surrounded by curly braces), the following restrictions apply:
The placeholder cannot be used as an object key.
The following example shows the syntax for using InputPathsMap
and InputTemplate
.
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate
include quote marks within a JSON string, escape each quote marks with a
slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate
can also be valid JSON with varibles in quotes or out, as in the following
example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
InputPathsMap
to customize the data sent to the target. Enclose each
InputPathsMaps
value in brackets: <value> The InputTemplate must be valid
JSON.
If InputTemplate
is a JSON object (surrounded by curly braces), the following restrictions
apply:
The placeholder cannot be used as an object key.
The following example shows the syntax for using InputPathsMap
and
InputTemplate
.
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state <status>"
}
To have the InputTemplate
include quote marks within a JSON string, escape each quote marks
with a slash, as in the following example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": "<instance> is in state \"<status>\""
}
The InputTemplate
can also be valid JSON with varibles in quotes or out, as in the following
example:
"InputTransformer":
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
}
public InputTransformer.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<InputTransformer.Builder,InputTransformer>
public static InputTransformer.Builder builder()
public static Class<? extends InputTransformer.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.