Package software.amazon.smithy.aws.apigateway.traits

Class GatewayResponse

java.lang.Object

software.amazon.smithy.aws.apigateway.traits.GatewayResponse

All Implemented Interfaces:

ToNode, ToSmithyBuilder<GatewayResponse>

public final class GatewayResponse
extends Object
implements ToNode, ToSmithyBuilder<GatewayResponse>

A gateway response configuration for a specific response type.

See Also:

• GatewayResponsesTrait

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GatewayResponse.Builder	Builder used to create a GatewayResponse.

Method Summary

Modifier and Type	Method	Description
static GatewayResponse.Builder	builder()	Creates a builder for a GatewayResponse.
boolean	equals(Object o)
static GatewayResponse	fromNode(Node node)	Creates a GatewayResponse from a Node.
Map<String,String>	getResponseParameters()	Gets the response parameters for the gateway response.
Map<String,String>	getResponseTemplates()	Gets the response templates for the gateway response.
Optional<String>	getStatusCode()	Gets the HTTP status code for the gateway response.
int	hashCode()
GatewayResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static GatewayResponse.Builder builder()

Creates a builder for a GatewayResponse.

Returns:

Returns the created builder.

fromNode

public static GatewayResponse fromNode(Node node)

Creates a GatewayResponse from a Node.

Parameters:

node - Node to deserialize.

Returns:

Returns the created GatewayResponse.

getStatusCode

public Optional<String> getStatusCode()

Gets the HTTP status code for the gateway response.

Returns:

Returns the optional status code.

getResponseParameters

public Map<String,String> getResponseParameters()

Gets the response parameters for the gateway response.

Returns:

Returns the immutable map of response parameters.

getResponseTemplates

public Map<String,String> getResponseTemplates()

Gets the response templates for the gateway response.

Returns:

Returns the immutable map of response templates.

toBuilder

public GatewayResponse.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<GatewayResponse>

Returns:

a builder for type T

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object