Class PutIntegrationResponseRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
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 Description PutIntegrationResponseRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PutIntegrationResponseRequest
addResponseParametersEntry(String key, String value)
PutIntegrationResponseRequest
addResponseTemplatesEntry(String key, String value)
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 request.boolean
equals(Object obj)
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()
Represents response parameters that can be read from the backend response.Map<String,String>
getResponseTemplates()
Specifies a put integration response's templates.String
getRestApiId()
Specifies a put integration response request's API identifier.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
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)
Represents response parameters that can be read from the backend response.void
setResponseTemplates(Map<String,String> responseTemplates)
Specifies a put integration response's templates.void
setRestApiId(String restApiId)
Specifies a put integration response request's API identifier.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; useful for testing and debugging.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)
Represents response parameters that can be read from the backend response.PutIntegrationResponseRequest
withResponseTemplates(Map<String,String> responseTemplates)
Specifies a put integration response's templates.PutIntegrationResponseRequest
withRestApiId(String restApiId)
Specifies a put integration response request's API identifier.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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setRestApiId
public void setRestApiId(String restApiId)
Specifies a put integration response request's API identifier.
- Parameters:
restApiId
- Specifies a put integration response request's API identifier.
-
getRestApiId
public String getRestApiId()
Specifies a put integration response request's API identifier.
- Returns:
- Specifies a put integration response request's API identifier.
-
withRestApiId
public PutIntegrationResponseRequest withRestApiId(String restApiId)
Specifies a put integration response request's API identifier.
- Parameters:
restApiId
- Specifies a put integration response request's API identifier.- 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()
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern
integration.response.header.{name}
.- Returns:
- Represents response parameters that can be read from the backend
response. Response parameters are represented as a key/value map,
with a destination as the key and a source as the value. A
destination must match an existing response parameter in the
Method. The source can be a header from the backend
response, or a static value. Static values are specified using
enclosing single quotes, and backend response headers can be read
using the pattern
integration.response.header.{name}
.
-
setResponseParameters
public void setResponseParameters(Map<String,String> responseParameters)
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern
integration.response.header.{name}
.- Parameters:
responseParameters
- Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the patternintegration.response.header.{name}
.
-
withResponseParameters
public PutIntegrationResponseRequest withResponseParameters(Map<String,String> responseParameters)
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern
integration.response.header.{name}
.- Parameters:
responseParameters
- Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the patternintegration.response.header.{name}
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addResponseParametersEntry
public PutIntegrationResponseRequest addResponseParametersEntry(String key, String value)
-
clearResponseParametersEntries
public PutIntegrationResponseRequest clearResponseParametersEntries()
Removes all the entries added into ResponseParameters. <p> 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)
-
clearResponseTemplatesEntries
public PutIntegrationResponseRequest clearResponseTemplatesEntries()
Removes all the entries added into ResponseTemplates. <p> Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public PutIntegrationResponseRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-