HttpParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.eventbridge.model.HttpParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HttpParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
These are custom parameter to be used when the target is an API Gateway REST APIs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpParameters()

Constructors
Constructor and Description
`HttpParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpParameters`	`addHeaderParametersEntry(String key, String value)` Add a single HeaderParameters entry
`HttpParameters`	`addQueryStringParametersEntry(String key, String value)` Add a single QueryStringParameters entry
`HttpParameters`	`clearHeaderParametersEntries()` Removes all the entries added into HeaderParameters.
`HttpParameters`	`clearQueryStringParametersEntries()` Removes all the entries added into QueryStringParameters.
`HttpParameters`	`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.
`List<String>`	`getPathParameterValues()` The path parameter values to be used to populate API Gateway REST API 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.
`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.
`void`	`setPathParameterValues(Collection<String> pathParameterValues)` The path parameter values to be used to populate API Gateway REST API 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.
`String`	`toString()` Returns a string representation of this object.
`HttpParameters`	`withHeaderParameters(Map<String,String> headerParameters)` The headers that need to be sent as part of request invoking the API Gateway REST API.
`HttpParameters`	`withPathParameterValues(Collection<String> pathParameterValues)` The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
`HttpParameters`	`withPathParameterValues(String... pathParameterValues)` The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
`HttpParameters`	`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HttpParameters
```
public HttpParameters()
```
- Method Detail
  - getPathParameterValues
```
public List<String> getPathParameterValues()
```
    The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
    
    Returns:
    
    The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
  - setPathParameterValues
```
public void setPathParameterValues(Collection<String> pathParameterValues)
```
    The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
    
    Parameters:
    
    pathParameterValues - The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
  - withPathParameterValues
```
public HttpParameters withPathParameterValues(String... pathParameterValues)
```
    The path parameter values to be used to populate API Gateway REST API 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.
    
    Parameters:
    
    pathParameterValues - The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPathParameterValues
```
public HttpParameters withPathParameterValues(Collection<String> pathParameterValues)
```
    The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
    
    Parameters:
    
    pathParameterValues - The path parameter values to be used to populate API Gateway REST API path wildcards ("*").
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHeaderParameters
```
public Map<String,String> getHeaderParameters()
```
    The headers that need to be sent as part of request invoking the API Gateway REST API.
    
    Returns:
    
    The headers that need to be sent as part of request invoking the API Gateway REST API.
  - setHeaderParameters
```
public void setHeaderParameters(Map<String,String> headerParameters)
```
    The headers that need to be sent as part of request invoking the API Gateway REST API.
    
    Parameters:
    
    headerParameters - The headers that need to be sent as part of request invoking the API Gateway REST API.
  - withHeaderParameters
```
public HttpParameters withHeaderParameters(Map<String,String> headerParameters)
```
    The headers that need to be sent as part of request invoking the API Gateway REST API.
    
    Parameters:
    
    headerParameters - The headers that need to be sent as part of request invoking the API Gateway REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addHeaderParametersEntry
```
public HttpParameters addHeaderParametersEntry(String key,
                                               String value)
```
    Add a single HeaderParameters entry
    
    See Also:
    
    withHeaderParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearHeaderParametersEntries
```
public HttpParameters clearHeaderParametersEntries()
```
    Removes all the entries added into HeaderParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getQueryStringParameters
```
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.
    
    Returns:
    
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.
  - setQueryStringParameters
```
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.
    
    Parameters:
    
    queryStringParameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.
  - withQueryStringParameters
```
public HttpParameters 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.
    
    Parameters:
    
    queryStringParameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addQueryStringParametersEntry
```
public HttpParameters addQueryStringParametersEntry(String key,
                                                    String value)
```
    Add a single QueryStringParameters entry
    
    See Also:
    
    withQueryStringParameters(java.util.Map<java.lang.String, java.lang.String>)
  - clearQueryStringParametersEntries
```
public HttpParameters clearQueryStringParametersEntries()
```
    Removes all the entries added into QueryStringParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HttpParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HttpParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpParameters

Method Detail

getPathParameterValues

setPathParameterValues

withPathParameterValues

withPathParameterValues

getHeaderParameters

setHeaderParameters

withHeaderParameters

addHeaderParametersEntry

clearHeaderParametersEntries

getQueryStringParameters

setQueryStringParameters

withQueryStringParameters

addQueryStringParametersEntry

clearQueryStringParametersEntries

toString

equals

hashCode

clone

marshall