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

Class MockIntegrationTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.aws.apigateway.traits.MockIntegrationTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<MockIntegrationTrait>

public final class MockIntegrationTrait
extends AbstractTrait
implements ToSmithyBuilder<MockIntegrationTrait>

API Gateway mock integration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MockIntegrationTrait.Builder
static class	MockIntegrationTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static MockIntegrationTrait.Builder	builder()
protected ObjectNode	createNode()	The result of toNode is used for hashCodes and equality.
java.util.Optional<java.lang.String>	getContentHandling()	Gets the contentHandling property of the integration.
java.util.Optional<java.lang.String>	getPassThroughBehavior()	Gets the pass through behavior of the integration.
java.util.Optional<java.lang.String>	getRequestParameter(java.lang.String expression)	Get a specific request parameter by input expression.
java.util.Map<java.lang.String,java.lang.String>	getRequestParameters()	Gets the request parameter mappings of the integration.
java.util.Optional<java.lang.String>	getRequestTemplate(java.lang.String mimeType)	Gets a specific request template by MIME type.
java.util.Map<java.lang.String,java.lang.String>	getRequestTemplates()	Gets all request templates of the integration.
java.util.Optional<IntegrationResponse>	getResponse(java.lang.String statusCode)	Get a specific integration response by status code expression.
java.util.Map<java.lang.String,IntegrationResponse>	getResponses()	Gets all integration responses.
MockIntegrationTrait.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final ShapeId ID

Method Detail

builder

public static MockIntegrationTrait.Builder builder()

getPassThroughBehavior

public java.util.Optional<java.lang.String> getPassThroughBehavior()

Gets the pass through behavior of the integration.

Specifies how a request payload of unmapped content type is passed through the integration request without modification. Supported values are when_no_templates, when_no_match, and never.

Returns:

Returns the pass through setting.

See Also:

Pass through behavior

getRequestParameters

public java.util.Map<java.lang.String,java.lang.String> getRequestParameters()

Gets the request parameter mappings of the integration.

Each key is an expression used to extract a value from the request, and each value is an expression of where to place the value in the downstream request. Supported request parameters are querystring, path, header, and body.

Returns:

Returns the request parameters.

See Also:

Request parameters

getRequestParameter

public java.util.Optional<java.lang.String> getRequestParameter(java.lang.String expression)

Get a specific request parameter by input expression.

Parameters:

expression - Expression to get.

Returns:

Returns the optionally found request parameter.

getRequestTemplates

public java.util.Map<java.lang.String,java.lang.String> getRequestTemplates()

Gets all request templates of the integration.

Returns:

Returns a map of MIME types to request templates.

See Also:

Request templates

getRequestTemplate

public java.util.Optional<java.lang.String> getRequestTemplate(java.lang.String mimeType)

Gets a specific request template by MIME type.

Parameters:

mimeType - MIME type to get.

Returns:

Returns the optionally found template.

getResponses

public java.util.Map<java.lang.String,IntegrationResponse> getResponses()

Gets all integration responses.

Returns:

Returns a map of status code regular expressions to responses.

See Also:

Integration responses

getResponse

public java.util.Optional<IntegrationResponse> getResponse(java.lang.String statusCode)

Get a specific integration response by status code expression.

Parameters:

statusCode - Status code regular expression to search for.

Returns:

Returns the optionally found response object.

getContentHandling

public java.util.Optional<java.lang.String> getContentHandling()

Gets the contentHandling property of the integration.

Returns:

Returns the contentHandling property.

createNode

protected ObjectNode createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public MockIntegrationTrait.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<MockIntegrationTrait>

Returns:

a builder for type T