Package software.amazon.awssdk.services.pipes.model

Class PipeEnrichmentParameters

java.lang.Object

software.amazon.awssdk.services.pipes.model.PipeEnrichmentParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipeEnrichmentParameters.Builder,PipeEnrichmentParameters>

@Generated("software.amazon.awssdk:codegen")
public final class PipeEnrichmentParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipeEnrichmentParameters.Builder,PipeEnrichmentParameters>

The parameters required to set up enrichment on your pipe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipeEnrichmentParameters.Builder

Method Summary

Modifier and Type	Method	Description
static PipeEnrichmentParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PipeEnrichmentHttpParameters	httpParameters()	Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
String	inputTemplate()	Valid JSON text passed to the enrichment.
List<SdkField<?>>	sdkFields()
static Class<? extends PipeEnrichmentParameters.Builder>	serializableBuilderClass()
PipeEnrichmentParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

httpParameters

public final PipeEnrichmentHttpParameters httpParameters()

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

Returns:

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

inputTemplate

public final String inputTemplate()

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.

Returns:

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.

toBuilder

public PipeEnrichmentParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PipeEnrichmentParameters.Builder,PipeEnrichmentParameters>

builder

public static PipeEnrichmentParameters.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo