@Generated(value="software.amazon.awssdk:codegen") public final class HttpParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HttpParameters.Builder,HttpParameters>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
HttpParameters.Builder |
Modifier and Type | Method and Description |
---|---|
static HttpParameters.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 HttpParameters.Builder> |
serializableBuilderClass() |
HttpParameters.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final boolean hasPathParameterValues()
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.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.
public final boolean hasHeaderParameters()
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.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.
public final boolean hasQueryStringParameters()
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.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.
public HttpParameters.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<HttpParameters.Builder,HttpParameters>
public static HttpParameters.Builder builder()
public static Class<? extends HttpParameters.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.