Class InputTransformer
- All Implemented Interfaces:
Serializable
,SdkPojo
,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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic InputTransformer.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputPathsMap property.Map of JSON paths to be extracted from the event.final String
Input template where you specify placeholders that will be filled with the values of the keys fromInputPathsMap
to customize the data sent to the target.static Class
<? extends InputTransformer.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasInputPathsMap
public final boolean hasInputPathsMap()For responses, this returns true if the service returned a value for the InputPathsMap property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- 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."
-
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 eachInputPathsMaps
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
andInputTemplate
."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>\""}'
}
- Returns:
- 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 eachInputPathsMaps
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
andInputTemplate
."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>\""}'
}
-
-
-
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 interfaceToCopyableBuilder<InputTransformer.Builder,
InputTransformer> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-