com.amazonaws.services.apigateway.model

Class PutIntegrationResponseRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutIntegrationResponseRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents a put integration response request.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutIntegrationResponseRequest()

Method Summary

Modifier and Type	Method and Description
PutIntegrationResponseRequest	addResponseParametersEntry(String key, String value) Add a single ResponseParameters entry
PutIntegrationResponseRequest	addResponseTemplatesEntry(String key, String value) Add a single ResponseTemplates entry
PutIntegrationResponseRequest	clearResponseParametersEntries() Removes all the entries added into ResponseParameters.
PutIntegrationResponseRequest	clearResponseTemplatesEntries() Removes all the entries added into ResponseTemplates.
PutIntegrationResponseRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getContentHandling() Specifies how to handle response payload content type conversions.
String	getHttpMethod() Specifies a put integration response request's HTTP method.
String	getResourceId() Specifies a put integration response request's resource identifier.
Map<String,String>	getResponseParameters() A key-value map specifying response parameters that are passed to the method response from the back end.
Map<String,String>	getResponseTemplates() Specifies a put integration response's templates.
String	getRestApiId() The string identifier of the associated RestApi.
String	getSelectionPattern() Specifies the selection pattern of a put integration response.
String	getStatusCode() Specifies the status code that is used to map the integration response to an existing MethodResponse.
int	hashCode()
void	setContentHandling(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.
void	setContentHandling(String contentHandling) Specifies how to handle response payload content type conversions.
void	setHttpMethod(String httpMethod) Specifies a put integration response request's HTTP method.
void	setResourceId(String resourceId) Specifies a put integration response request's resource identifier.
void	setResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.
void	setResponseTemplates(Map<String,String> responseTemplates) Specifies a put integration response's templates.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
void	setSelectionPattern(String selectionPattern) Specifies the selection pattern of a put integration response.
void	setStatusCode(String statusCode) Specifies the status code that is used to map the integration response to an existing MethodResponse.
String	toString() Returns a string representation of this object.
PutIntegrationResponseRequest	withContentHandling(ContentHandlingStrategy contentHandling) Specifies how to handle response payload content type conversions.
PutIntegrationResponseRequest	withContentHandling(String contentHandling) Specifies how to handle response payload content type conversions.
PutIntegrationResponseRequest	withHttpMethod(String httpMethod) Specifies a put integration response request's HTTP method.
PutIntegrationResponseRequest	withResourceId(String resourceId) Specifies a put integration response request's resource identifier.
PutIntegrationResponseRequest	withResponseParameters(Map<String,String> responseParameters) A key-value map specifying response parameters that are passed to the method response from the back end.
PutIntegrationResponseRequest	withResponseTemplates(Map<String,String> responseTemplates) Specifies a put integration response's templates.
PutIntegrationResponseRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.
PutIntegrationResponseRequest	withSelectionPattern(String selectionPattern) Specifies the selection pattern of a put integration response.
PutIntegrationResponseRequest	withStatusCode(String statusCode) Specifies the status code that is used to map the integration response to an existing MethodResponse.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutIntegrationResponseRequest

public PutIntegrationResponseRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

getRestApiId

public String getRestApiId()

The string identifier of the associated RestApi.

Returns:

The string identifier of the associated RestApi.

withRestApiId

public PutIntegrationResponseRequest withRestApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

setResourceId

public void setResourceId(String resourceId)

Specifies a put integration response request's resource identifier.

Parameters:

resourceId - Specifies a put integration response request's resource identifier.

getResourceId

public String getResourceId()

Specifies a put integration response request's resource identifier.

Returns:

Specifies a put integration response request's resource identifier.

withResourceId

public PutIntegrationResponseRequest withResourceId(String resourceId)

Specifies a put integration response request's resource identifier.

Parameters:

resourceId - Specifies a put integration response request's resource identifier.

Returns:

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

setHttpMethod

public void setHttpMethod(String httpMethod)

Specifies a put integration response request's HTTP method.

Parameters:

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

getHttpMethod

public String getHttpMethod()

Specifies a put integration response request's HTTP method.

Returns:

Specifies a put integration response request's HTTP method.

withHttpMethod

public PutIntegrationResponseRequest withHttpMethod(String httpMethod)

Specifies a put integration response request's HTTP method.

Parameters:

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

Returns:

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

setStatusCode

public void setStatusCode(String statusCode)

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Parameters:

statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

getStatusCode

public String getStatusCode()

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Returns:

Specifies the status code that is used to map the integration response to an existing MethodResponse.

withStatusCode

public PutIntegrationResponseRequest withStatusCode(String statusCode)

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Parameters:

statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

Returns:

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

setSelectionPattern

public void setSelectionPattern(String selectionPattern)

Specifies the selection pattern of a put integration response.

Parameters:

selectionPattern - Specifies the selection pattern of a put integration response.

getSelectionPattern

public String getSelectionPattern()

Specifies the selection pattern of a put integration response.

Returns:

Specifies the selection pattern of a put integration response.

withSelectionPattern

public PutIntegrationResponseRequest withSelectionPattern(String selectionPattern)

Specifies the selection pattern of a put integration response.

Parameters:

selectionPattern - Specifies the selection pattern of a put integration response.

Returns:

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

getResponseParameters

public Map<String,String> getResponseParameters()

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Returns:

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

setResponseParameters

public void setResponseParameters(Map<String,String> responseParameters)

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

withResponseParameters

public PutIntegrationResponseRequest withResponseParameters(Map<String,String> responseParameters)

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Parameters:

responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

Returns:

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

addResponseParametersEntry

public PutIntegrationResponseRequest addResponseParametersEntry(String key,
                                                                String value)

Add a single ResponseParameters entry

See Also:

withResponseParameters(java.util.Map<java.lang.String, java.lang.String>)

clearResponseParametersEntries

public PutIntegrationResponseRequest clearResponseParametersEntries()

Removes all the entries added into ResponseParameters.

Returns:

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

getResponseTemplates

public Map<String,String> getResponseTemplates()

Specifies a put integration response's templates.

Returns:

Specifies a put integration response's templates.

setResponseTemplates

public void setResponseTemplates(Map<String,String> responseTemplates)

Specifies a put integration response's templates.

Parameters:

responseTemplates - Specifies a put integration response's templates.

withResponseTemplates

public PutIntegrationResponseRequest withResponseTemplates(Map<String,String> responseTemplates)

Specifies a put integration response's templates.

Parameters:

responseTemplates - Specifies a put integration response's templates.

Returns:

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

addResponseTemplatesEntry

public PutIntegrationResponseRequest addResponseTemplatesEntry(String key,
                                                               String value)

Add a single ResponseTemplates entry

See Also:

withResponseTemplates(java.util.Map<java.lang.String, java.lang.String>)

clearResponseTemplatesEntries

public PutIntegrationResponseRequest clearResponseTemplatesEntries()

Removes all the entries added into ResponseTemplates.

Returns:

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

setContentHandling

public void setContentHandling(String contentHandling)

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Parameters:

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

See Also:

ContentHandlingStrategy

getContentHandling

public String getContentHandling()

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

See Also:

ContentHandlingStrategy

withContentHandling

public PutIntegrationResponseRequest withContentHandling(String contentHandling)

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Parameters:

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:

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

See Also:

ContentHandlingStrategy

setContentHandling

public void setContentHandling(ContentHandlingStrategy contentHandling)

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Parameters:

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

See Also:

ContentHandlingStrategy

withContentHandling

public PutIntegrationResponseRequest withContentHandling(ContentHandlingStrategy contentHandling)

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Parameters:

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Returns:

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

See Also:

ContentHandlingStrategy

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutIntegrationResponseRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()