software.amazon.awssdk.services.cloudwatchevents.model

Class HttpParameters

java.lang.Object

software.amazon.awssdk.services.cloudwatchevents.model.HttpParameters

All Implemented Interfaces:

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

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpParameters.Builder

Method Summary

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() Returns true if the HeaderParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPathParameterValues() Returns true if the PathParameterValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasQueryStringParameters() Returns true if the QueryStringParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,String>	headerParameters() The headers that need to be sent as part of request invoking the API Gateway REST API.
List<String>	pathParameterValues() The path parameter values to be used to populate API Gateway REST API 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.
List<SdkField<?>>	sdkFields()
static Class<? extends HttpParameters.Builder>	serializableBuilderClass()
HttpParameters.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

hasPathParameterValues

public boolean hasPathParameterValues()

Returns true if the PathParameterValues property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

pathParameterValues

public List<String> pathParameterValues()

The path parameter values to be used to populate API Gateway REST API path wildcards ("*").

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPathParameterValues() to see if a value was sent in this field.

Returns:

The path parameter values to be used to populate API Gateway REST API path wildcards ("*").

hasHeaderParameters

public boolean hasHeaderParameters()

Returns true if the HeaderParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

headerParameters

public Map<String,String> headerParameters()

The headers that need to be sent as part of request invoking the API Gateway REST API.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHeaderParameters() to see if a value was sent in this field.

Returns:

The headers that need to be sent as part of request invoking the API Gateway REST API.

hasQueryStringParameters

public boolean hasQueryStringParameters()

Returns true if the QueryStringParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

queryStringParameters

public Map<String,String> queryStringParameters()

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasQueryStringParameters() to see if a value was sent in this field.

Returns:

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

toBuilder

public HttpParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HttpParameters.Builder,HttpParameters>

builder

public static HttpParameters.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo