java.lang.Object
- software.amazon.awssdk.services.pipes.model.PipeEnrichmentHttpParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PipeEnrichmentHttpParameters.Builder,PipeEnrichmentHttpParameters>
```
@Generated("software.amazon.awssdk:codegen")
public final class PipeEnrichmentHttpParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PipeEnrichmentHttpParameters.Builder,PipeEnrichmentHttpParameters>
```
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PipeEnrichmentHttpParameters.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PipeEnrichmentHttpParameters.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasHeaderParameters()`	For responses, this returns true if the service returned a value for the HeaderParameters property.
`boolean`	`hasPathParameterValues()`	For responses, this returns true if the service returned a value for the PathParameterValues property.
`boolean`	`hasQueryStringParameters()`	For responses, this returns true if the service returned a value for the QueryStringParameters property.
`Map<String,String>`	`headerParameters()`	The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
`List<String>`	`pathParameterValues()`	The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
`Map<String,String>`	`queryStringParameters()`	The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PipeEnrichmentHttpParameters.Builder>`	`serializableBuilderClass()`
`PipeEnrichmentHttpParameters.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
  - hasHeaderParameters
```
public final boolean hasHeaderParameters()
```
    For responses, this returns true if the service returned a value for the HeaderParameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - headerParameters
```
public final Map<String,String> headerParameters()
```
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    
    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 hasHeaderParameters() method.
    
    Returns:
    
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
  - hasPathParameterValues
```
public final boolean hasPathParameterValues()
```
    For responses, this returns true if the service returned a value for the PathParameterValues property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - pathParameterValues
```
public final List<String> pathParameterValues()
```
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    
    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 hasPathParameterValues() method.
    
    Returns:
    
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
  - hasQueryStringParameters
```
public final boolean hasQueryStringParameters()
```
    For responses, this returns true if the service returned a value for the QueryStringParameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - queryStringParameters
```
public final Map<String,String> queryStringParameters()
```
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    
    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 hasQueryStringParameters() method.
    
    Returns:
    
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
  - toBuilder
```
public PipeEnrichmentHttpParameters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PipeEnrichmentHttpParameters.Builder,PipeEnrichmentHttpParameters>
  - builder
```
public static PipeEnrichmentHttpParameters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PipeEnrichmentHttpParameters.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

Class PipeEnrichmentHttpParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasHeaderParameters

headerParameters

hasPathParameterValues

pathParameterValues

hasQueryStringParameters

queryStringParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields