@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PipeTargetHttpParameters extends Object implements Serializable, Cloneable, StructuredPojo
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
Constructor and Description |
---|
PipeTargetHttpParameters() |
Modifier and Type | Method and Description |
---|---|
PipeTargetHttpParameters |
addHeaderParametersEntry(String key,
String value)
Add a single HeaderParameters entry
|
PipeTargetHttpParameters |
addQueryStringParametersEntry(String key,
String value)
Add a single QueryStringParameters entry
|
PipeTargetHttpParameters |
clearHeaderParametersEntries()
Removes all the entries added into HeaderParameters.
|
PipeTargetHttpParameters |
clearQueryStringParametersEntries()
Removes all the entries added into QueryStringParameters.
|
PipeTargetHttpParameters |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getHeaderParameters()
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge
ApiDestination.
|
List<String> |
getPathParameterValues()
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").
|
Map<String,String> |
getQueryStringParameters()
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or
EventBridge ApiDestination.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setHeaderParameters(Map<String,String> headerParameters)
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge
ApiDestination.
|
void |
setPathParameterValues(Collection<String> pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").
|
void |
setQueryStringParameters(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.
|
String |
toString()
Returns a string representation of this object.
|
PipeTargetHttpParameters |
withHeaderParameters(Map<String,String> headerParameters)
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge
ApiDestination.
|
PipeTargetHttpParameters |
withPathParameterValues(Collection<String> pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").
|
PipeTargetHttpParameters |
withPathParameterValues(String... pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").
|
PipeTargetHttpParameters |
withQueryStringParameters(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.
|
public Map<String,String> getHeaderParameters()
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
public void setHeaderParameters(Map<String,String> headerParameters)
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
headerParameters
- The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge
ApiDestination.public PipeTargetHttpParameters withHeaderParameters(Map<String,String> headerParameters)
The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
headerParameters
- The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge
ApiDestination.public PipeTargetHttpParameters addHeaderParametersEntry(String key, String value)
public PipeTargetHttpParameters clearHeaderParametersEntries()
public List<String> getPathParameterValues()
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
public void setPathParameterValues(Collection<String> pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
pathParameterValues
- The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").public PipeTargetHttpParameters withPathParameterValues(String... pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
NOTE: This method appends the values to the existing list (if any). Use
setPathParameterValues(java.util.Collection)
or withPathParameterValues(java.util.Collection)
if you want to override the existing values.
pathParameterValues
- The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").public PipeTargetHttpParameters withPathParameterValues(Collection<String> pathParameterValues)
The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
pathParameterValues
- The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path
wildcards ("*").public Map<String,String> getQueryStringParameters()
The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
public void setQueryStringParameters(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.
queryStringParameters
- The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or
EventBridge ApiDestination.public PipeTargetHttpParameters withQueryStringParameters(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.
queryStringParameters
- The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or
EventBridge ApiDestination.public PipeTargetHttpParameters addQueryStringParametersEntry(String key, String value)
public PipeTargetHttpParameters clearQueryStringParametersEntries()
public String toString()
toString
in class Object
Object.toString()
public PipeTargetHttpParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.