com.amazonaws.services.apigateway.model

Class PutMethodResponseRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutMethodResponseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Request to add a MethodResponse to an existing Method resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutMethodResponseRequest()

Method Summary

Modifier and Type	Method and Description
PutMethodResponseRequest	addResponseModelsEntry(String key, String value) Add a single ResponseModels entry
PutMethodResponseRequest	addResponseParametersEntry(String key, Boolean value) Add a single ResponseParameters entry
PutMethodResponseRequest	clearResponseModelsEntries() Removes all the entries added into ResponseModels.
PutMethodResponseRequest	clearResponseParametersEntries() Removes all the entries added into ResponseParameters.
PutMethodResponseRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getHttpMethod() The HTTP verb of the Method resource.
String	getResourceId() The Resource identifier for the Method resource.
Map<String,String>	getResponseModels() Specifies the Model resources used for the response's content type.
Map<String,Boolean>	getResponseParameters() A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
String	getRestApiId() The string identifier of the associated RestApi.
String	getStatusCode() The method response's status code.
int	hashCode()
void	setHttpMethod(String httpMethod) The HTTP verb of the Method resource.
void	setResourceId(String resourceId) The Resource identifier for the Method resource.
void	setResponseModels(Map<String,String> responseModels) Specifies the Model resources used for the response's content type.
void	setResponseParameters(Map<String,Boolean> responseParameters) A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
void	setStatusCode(String statusCode) The method response's status code.
String	toString() Returns a string representation of this object.
PutMethodResponseRequest	withHttpMethod(String httpMethod) The HTTP verb of the Method resource.
PutMethodResponseRequest	withResourceId(String resourceId) The Resource identifier for the Method resource.
PutMethodResponseRequest	withResponseModels(Map<String,String> responseModels) Specifies the Model resources used for the response's content type.
PutMethodResponseRequest	withResponseParameters(Map<String,Boolean> responseParameters) A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
PutMethodResponseRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.
PutMethodResponseRequest	withStatusCode(String statusCode) The method response's status code.

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

PutMethodResponseRequest

public PutMethodResponseRequest()

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 PutMethodResponseRequest 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)

The Resource identifier for the Method resource.

Parameters:

resourceId - The Resource identifier for the Method resource.

getResourceId

public String getResourceId()

The Resource identifier for the Method resource.

Returns:

The Resource identifier for the Method resource.

withResourceId

public PutMethodResponseRequest withResourceId(String resourceId)

The Resource identifier for the Method resource.

Parameters:

resourceId - The Resource identifier for the Method resource.

Returns:

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

setHttpMethod

public void setHttpMethod(String httpMethod)

The HTTP verb of the Method resource.

Parameters:

httpMethod - The HTTP verb of the Method resource.

getHttpMethod

public String getHttpMethod()

The HTTP verb of the Method resource.

Returns:

The HTTP verb of the Method resource.

withHttpMethod

public PutMethodResponseRequest withHttpMethod(String httpMethod)

The HTTP verb of the Method resource.

Parameters:

httpMethod - The HTTP verb of the Method resource.

Returns:

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

setStatusCode

public void setStatusCode(String statusCode)

The method response's status code.

Parameters:

statusCode - The method response's status code.

getStatusCode

public String getStatusCode()

The method response's status code.

Returns:

The method response's status code.

withStatusCode

public PutMethodResponseRequest withStatusCode(String statusCode)

The method response's status code.

Parameters:

statusCode - The method response's status code.

Returns:

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

getResponseParameters

public Map<String,Boolean> getResponseParameters()

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Returns:

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

setResponseParameters

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

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Parameters:

responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

withResponseParameters

public PutMethodResponseRequest withResponseParameters(Map<String,Boolean> responseParameters)

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Parameters:

responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Returns:

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

addResponseParametersEntry

public PutMethodResponseRequest addResponseParametersEntry(String key,
                                                           Boolean value)

Add a single ResponseParameters entry

See Also:

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

clearResponseParametersEntries

public PutMethodResponseRequest clearResponseParametersEntries()

Removes all the entries added into ResponseParameters.

Returns:

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

getResponseModels

public Map<String,String> getResponseModels()

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Returns:

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

setResponseModels

public void setResponseModels(Map<String,String> responseModels)

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Parameters:

responseModels - Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

withResponseModels

public PutMethodResponseRequest withResponseModels(Map<String,String> responseModels)

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Parameters:

responseModels - Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

Returns:

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

addResponseModelsEntry

public PutMethodResponseRequest addResponseModelsEntry(String key,
                                                       String value)

Add a single ResponseModels entry

See Also:

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

clearResponseModelsEntries

public PutMethodResponseRequest clearResponseModelsEntries()

Removes all the entries added into ResponseModels.

Returns:

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. 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 PutMethodResponseRequest 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()