Package software.amazon.awscdk.services.apigateway

Class GatewayResponseOptions.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.GatewayResponseOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GatewayResponseOptions>

Enclosing interface:

GatewayResponseOptions

@Stability(Stable)
public static final class GatewayResponseOptions.Builder
extends Object
implements software.amazon.jsii.Builder<GatewayResponseOptions>

A builder for GatewayResponseOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GatewayResponseOptions	build()	Builds the configured instance.
GatewayResponseOptions.Builder	responseHeaders(Map<String,String> responseHeaders)	Sets the value of GatewayResponseOptions.getResponseHeaders()
GatewayResponseOptions.Builder	statusCode(String statusCode)	Sets the value of GatewayResponseOptions.getStatusCode()
GatewayResponseOptions.Builder	templates(Map<String,String> templates)	Sets the value of GatewayResponseOptions.getTemplates()
GatewayResponseOptions.Builder	type(ResponseType type)	Sets the value of GatewayResponseOptions.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

type

@Stability(Stable)
public GatewayResponseOptions.Builder type(ResponseType type)

Sets the value of GatewayResponseOptions.getType()

Parameters:

type - Response type to associate with gateway response. This parameter is required.

Returns:

this

responseHeaders

@Stability(Stable)
public GatewayResponseOptions.Builder responseHeaders(Map<String,String> responseHeaders)

Sets the value of GatewayResponseOptions.getResponseHeaders()

Parameters:

responseHeaders - Custom headers parameters for response.

Returns:

this

statusCode

@Stability(Stable)
public GatewayResponseOptions.Builder statusCode(String statusCode)

Sets the value of GatewayResponseOptions.getStatusCode()

Parameters:

statusCode - Http status code for response.

Returns:

this

templates

@Stability(Stable)
public GatewayResponseOptions.Builder templates(Map<String,String> templates)

Sets the value of GatewayResponseOptions.getTemplates()

Parameters:

templates - Custom templates to get mapped as response.

Returns:

this

build

@Stability(Stable)
public GatewayResponseOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GatewayResponseOptions>

Returns:

a new instance of GatewayResponseOptions

Throws:

NullPointerException - if any required attribute was not provided