Package software.amazon.awssdk.services.apigateway.model

Interface PutIntegrationRequest.Builder

All Superinterfaces:

CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>, SdkBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

Enclosing class:

PutIntegrationRequest

public static interface PutIntegrationRequest.Builder
extends CopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

Method Summary

Modifier and Type	Method	Description
PutIntegrationRequest.Builder	cacheKeyParameters(String... cacheKeyParameters)	Specifies a put integration input's cache key parameters.
PutIntegrationRequest.Builder	cacheKeyParameters(Collection<String> cacheKeyParameters)	Specifies a put integration input's cache key parameters.
PutIntegrationRequest.Builder	cacheNamespace(String cacheNamespace)	Specifies a put integration input's cache namespace.
PutIntegrationRequest.Builder	contentHandling(String contentHandling)	Specifies how to handle request payload content type conversions.
PutIntegrationRequest.Builder	contentHandling(ContentHandlingStrategy contentHandling)	Specifies how to handle request payload content type conversions.
PutIntegrationRequest.Builder	credentials(String credentials)	Specifies whether credentials are required for a put integration.
PutIntegrationRequest.Builder	httpMethod(String httpMethod)	Specifies a put integration request's HTTP method.
PutIntegrationRequest.Builder	integrationHttpMethod(String integrationHttpMethod)	Specifies a put integration HTTP method.
PutIntegrationRequest.Builder	passthroughBehavior(String passthroughBehavior)	Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
PutIntegrationRequest.Builder	requestParameters(Map<String,String> requestParameters)	A key-value map specifying request parameters that are passed from the method request to the back end.
PutIntegrationRequest.Builder	requestTemplates(Map<String,String> requestTemplates)	Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
PutIntegrationRequest.Builder	resourceId(String resourceId)	Specifies a put integration request's resource ID.
PutIntegrationRequest.Builder	restApiId(String restApiId)	Specifies a put integration request's API identifier.
PutIntegrationRequest.Builder	type(String type)	Specifies a put integration input's type.
PutIntegrationRequest.Builder	type(IntegrationType type)	Specifies a put integration input's type.
PutIntegrationRequest.Builder	uri(String uri)	Specifies a put integration input's Uniform Resource Identifier (URI).

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

restApiId

PutIntegrationRequest.Builder restApiId(String restApiId)

Specifies a put integration request's API identifier.

Parameters:

restApiId - Specifies a put integration request's API identifier.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceId

PutIntegrationRequest.Builder resourceId(String resourceId)

Specifies a put integration request's resource ID.

Parameters:

resourceId - Specifies a put integration request's resource ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpMethod

PutIntegrationRequest.Builder httpMethod(String httpMethod)

Specifies a put integration request's HTTP method.

Parameters:

httpMethod - Specifies a put integration request's HTTP method.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

PutIntegrationRequest.Builder type(String type)

Specifies a put integration input's type.

Parameters:

type - Specifies a put integration input's type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IntegrationType

type

PutIntegrationRequest.Builder type(IntegrationType type)

Specifies a put integration input's type.

Parameters:

type - Specifies a put integration input's type.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IntegrationType

integrationHttpMethod

PutIntegrationRequest.Builder integrationHttpMethod(String integrationHttpMethod)

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Parameters:

integrationHttpMethod - Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

Returns:

Returns a reference to this object so that method calls can be chained together.

uri

PutIntegrationRequest.Builder uri(String uri)

Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.

Parameters:

uri - Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.

Returns:

Returns a reference to this object so that method calls can be chained together.

credentials

PutIntegrationRequest.Builder credentials(String credentials)

Specifies whether credentials are required for a put integration.

Parameters:

credentials - Specifies whether credentials are required for a put integration.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestParameters

PutIntegrationRequest.Builder requestParameters(Map<String,String> requestParameters)

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

Parameters:

requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring , path, or header and name must be a valid and unique method request parameter name.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestTemplates

PutIntegrationRequest.Builder requestTemplates(Map<String,String> requestTemplates)

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Parameters:

requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

Returns:

Returns a reference to this object so that method calls can be chained together.

passthroughBehavior

PutIntegrationRequest.Builder passthroughBehavior(String passthroughBehavior)

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

• WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

• NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

• WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Parameters:

passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

• WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

• NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

• WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheNamespace

PutIntegrationRequest.Builder cacheNamespace(String cacheNamespace)

Specifies a put integration input's cache namespace.

Parameters:

cacheNamespace - Specifies a put integration input's cache namespace.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheKeyParameters

PutIntegrationRequest.Builder cacheKeyParameters(Collection<String> cacheKeyParameters)

Specifies a put integration input's cache key parameters.

Parameters:

cacheKeyParameters - Specifies a put integration input's cache key parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheKeyParameters

PutIntegrationRequest.Builder cacheKeyParameters(String... cacheKeyParameters)

Specifies a put integration input's cache key parameters.

NOTE: This method appends the values to the existing list (if any). Use #setCacheKeyParameters(java.util.Collection) or #withCacheKeyParameters(java.util.Collection) if you want to override the existing values.

Parameters:

cacheKeyParameters - Specifies a put integration input's cache key parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentHandling

PutIntegrationRequest.Builder contentHandling(String contentHandling)

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

• CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

• CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Parameters:

contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

• CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

• CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy

contentHandling

PutIntegrationRequest.Builder contentHandling(ContentHandlingStrategy contentHandling)

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

• CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

• CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Parameters:

contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

• CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

• CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentHandlingStrategy