Package software.amazon.awssdk.services.apigatewayv2.model

Class RouteResponse

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.RouteResponse

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class RouteResponse
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteResponse.Builder,RouteResponse>

Represents a route response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteResponse.Builder

Method Summary

Modifier and Type	Method	Description
static RouteResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResponseModels()	For responses, this returns true if the service returned a value for the ResponseModels property.
boolean	hasResponseParameters()	For responses, this returns true if the service returned a value for the ResponseParameters property.
String	modelSelectionExpression()	Represents the model selection expression of a route response.
Map<String,String>	responseModels()	Represents the response models of a route response.
Map<String,ParameterConstraints>	responseParameters()	Represents the response parameters of a route response.
String	routeResponseId()	Represents the identifier of a route response.
String	routeResponseKey()	Represents the route response key of a route response.
List<SdkField<?>>	sdkFields()
static Class<? extends RouteResponse.Builder>	serializableBuilderClass()
RouteResponse.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

modelSelectionExpression

public final String modelSelectionExpression()

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

Returns:

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

hasResponseModels

public final boolean hasResponseModels()

For responses, this returns true if the service returned a value for the ResponseModels 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.

responseModels

public final Map<String,String> responseModels()

Represents the response models of a route response.

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 hasResponseModels() method.

Returns:

Represents the response models of a route response.

hasResponseParameters

public final boolean hasResponseParameters()

For responses, this returns true if the service returned a value for the ResponseParameters 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.

responseParameters

public final Map<String,ParameterConstraints> responseParameters()

Represents the response parameters of a route response.

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 hasResponseParameters() method.

Returns:

Represents the response parameters of a route response.

routeResponseId

public final String routeResponseId()

Represents the identifier of a route response.

Returns:

Represents the identifier of a route response.

routeResponseKey

public final String routeResponseKey()

Represents the route response key of a route response.

Returns:

Represents the route response key of a route response.

toBuilder

public RouteResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteResponse.Builder,RouteResponse>

builder

public static RouteResponse.Builder builder()

serializableBuilderClass

public static Class<? extends RouteResponse.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