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

Class PutIntegrationRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.PutIntegrationRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

@Generated("software.amazon.awssdk:codegen")
public class PutIntegrationRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

Represents a put integration request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutIntegrationRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static PutIntegrationRequest.Builder	builder()
List<String>	cacheKeyParameters()	Specifies a put integration input's cache key parameters.
String	cacheNamespace()	Specifies a put integration input's cache namespace.
String	contentHandling()	Specifies how to handle request payload content type conversions.
String	credentials()	Specifies whether credentials are required for a put integration.
boolean	equals(Object obj)
int	hashCode()
String	httpMethod()	Specifies a put integration request's HTTP method.
String	integrationHttpMethod()	Specifies a put integration HTTP method.
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.
Map<String,String>	requestParameters()	A key-value map specifying request parameters that are passed from the method request to the back end.
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.
String	resourceId()	Specifies a put integration request's resource ID.
String	restApiId()	Specifies a put integration request's API identifier.
static Class<? extends PutIntegrationRequest.Builder>	serializableBuilderClass()
PutIntegrationRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	Specifies a put integration input's type.
String	uri()	Specifies a put integration input's Uniform Resource Identifier (URI).

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

Specifies a put integration request's API identifier.

Returns:

Specifies a put integration request's API identifier.

resourceId

public String resourceId()

Specifies a put integration request's resource ID.

Returns:

Specifies a put integration request's resource ID.

httpMethod

public String httpMethod()

Specifies a put integration request's HTTP method.

Returns:

Specifies a put integration request's HTTP method.

type

public String type()

Specifies a put integration input's type.

Returns:

Specifies a put integration input's type.

See Also:

IntegrationType

integrationHttpMethod

public String integrationHttpMethod()

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

Returns:

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

uri

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

Returns:

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.

credentials

public String credentials()

Specifies whether credentials are required for a put integration.

Returns:

Specifies whether credentials are required for a put integration.

requestParameters

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

Returns:

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.

requestTemplates

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

Returns:

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.

passthroughBehavior

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

Returns:

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.

cacheNamespace

public String cacheNamespace()

Specifies a put integration input's cache namespace.

Returns:

Specifies a put integration input's cache namespace.

cacheKeyParameters

public List<String> cacheKeyParameters()

Specifies a put integration input's cache key parameters.

Returns:

Specifies a put integration input's cache key parameters.

contentHandling

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

Returns:

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.

See Also:

ContentHandlingStrategy

toBuilder

public PutIntegrationRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

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

Specified by:

toBuilder in interface ToCopyableBuilder<PutIntegrationRequest.Builder,PutIntegrationRequest>

Returns:

a builder for type T

builder

public static PutIntegrationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutIntegrationRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object