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

Class IntegrationResponse.Builder

java.lang.Object

software.amazon.smithy.aws.apigateway.traits.IntegrationResponse.Builder

All Implemented Interfaces:

SmithyBuilder<IntegrationResponse>

Enclosing class:

IntegrationResponse

public static final class IntegrationResponse.Builder
extends Object
implements SmithyBuilder<IntegrationResponse>

Builds a IntegrationResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IntegrationResponse	build()	Creates an immutable object that is created from the properties that have been set on the builder.
IntegrationResponse.Builder	contentHandling(String contentHandling)	Sets the content handling of the response template.
IntegrationResponse.Builder	putResponseParameter(String name, String value)	Sets a response parameter mapping.
IntegrationResponse.Builder	putResponseTemplate(String mimeType, String template)	Adds a response template for a MIME type.
IntegrationResponse.Builder	removeResponseParameter(String name)	Removes a response parameter mapping.
IntegrationResponse.Builder	removeResponseTemplate(String mimeType)	Remove a response template for a given MIME type.
IntegrationResponse.Builder	responseParameters(Map<String,String> responseParameters)	Sets response parameter mappings.
IntegrationResponse.Builder	responseTemplates(Map<String,String> responseTemplates)	Sets a mapping of response MIME types to templates.
IntegrationResponse.Builder	statusCode(String statusCode)	Sets the status code of the response.

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

build

public IntegrationResponse build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface SmithyBuilder<IntegrationResponse>

Returns:

an instance of T

statusCode

public IntegrationResponse.Builder statusCode(String statusCode)

Sets the status code of the response.

Parameters:

statusCode - HTTP response status code.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getStatusCode()

contentHandling

public IntegrationResponse.Builder contentHandling(String contentHandling)

Sets the content handling of the response template.

Parameters:

contentHandling - Content handling strategy to set.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getContentHandling()

responseTemplates

public IntegrationResponse.Builder responseTemplates(Map<String,String> responseTemplates)

Sets a mapping of response MIME types to templates.

Parameters:

responseTemplates - Map of MIME types to response templates.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getResponseTemplates()

putResponseTemplate

public IntegrationResponse.Builder putResponseTemplate(String mimeType,
 String template)

Adds a response template for a MIME type.

Parameters:

mimeType - MIME type of the response template.

template - Response template for the payload.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getResponseTemplates()

removeResponseTemplate

public IntegrationResponse.Builder removeResponseTemplate(String mimeType)

Remove a response template for a given MIME type.

Parameters:

mimeType - MIME type to remove.

Returns:

Returns the builder.

responseParameters

public IntegrationResponse.Builder responseParameters(Map<String,String> responseParameters)

Sets response parameter mappings.

Parameters:

responseParameters - Map of response expressions to expressions to apply to response.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getResponseParameters()

putResponseParameter

public IntegrationResponse.Builder putResponseParameter(String name,
 String value)

Sets a response parameter mapping.

Parameters:

name - Name of the expression to extract.

value - Expression used to apply in the response.

Returns:

Returns the builder.

See Also:

• IntegrationResponse.getResponseParameters()

removeResponseParameter

public IntegrationResponse.Builder removeResponseParameter(String name)

Removes a response parameter mapping.

Parameters:

name - Expression to remove.

Returns:

Returns the builder.