com.amazonaws.services.apigateway.model

Class UpdateMethodResult

java.lang.Object

com.amazonaws.services.apigateway.model.UpdateMethodResult

All Implemented Interfaces:

Serializable, Cloneable

public class UpdateMethodResult
extends Object
implements Serializable, Cloneable

Represents a method.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateMethodResult()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateMethodResult	addMethodResponsesEntry(String key, MethodResponse value)
UpdateMethodResult	addRequestModelsEntry(String key, String value)
UpdateMethodResult	addRequestParametersEntry(String key, Boolean value)
UpdateMethodResult	clearMethodResponsesEntries() Removes all the entries added into MethodResponses.
UpdateMethodResult	clearRequestModelsEntries() Removes all the entries added into RequestModels.
UpdateMethodResult	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
UpdateMethodResult	clone()
boolean	equals(Object obj)
Boolean	getApiKeyRequired() Specifies whether the method requires a valid ApiKey.
String	getAuthorizationType() The method's authorization type.
String	getAuthorizerId() Specifies the identifier of an Authorizer to use on this Method.
String	getHttpMethod() The HTTP method.
Integration	getMethodIntegration() The method's integration.
Map<String,MethodResponse>	getMethodResponses() Represents available responses that can be sent to the caller.
Map<String,String>	getRequestModels() Specifies the Model resources used for the request's content type.
Map<String,Boolean>	getRequestParameters() Represents request parameters that can be accepted by Amazon API Gateway.
int	hashCode()
Boolean	isApiKeyRequired() Specifies whether the method requires a valid ApiKey.
void	setApiKeyRequired(Boolean apiKeyRequired) Specifies whether the method requires a valid ApiKey.
void	setAuthorizationType(String authorizationType) The method's authorization type.
void	setAuthorizerId(String authorizerId) Specifies the identifier of an Authorizer to use on this Method.
void	setHttpMethod(String httpMethod) The HTTP method.
void	setMethodIntegration(Integration methodIntegration) The method's integration.
void	setMethodResponses(Map<String,MethodResponse> methodResponses) Represents available responses that can be sent to the caller.
void	setRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
void	setRequestParameters(Map<String,Boolean> requestParameters) Represents request parameters that can be accepted by Amazon API Gateway.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateMethodResult	withApiKeyRequired(Boolean apiKeyRequired) Specifies whether the method requires a valid ApiKey.
UpdateMethodResult	withAuthorizationType(String authorizationType) The method's authorization type.
UpdateMethodResult	withAuthorizerId(String authorizerId) Specifies the identifier of an Authorizer to use on this Method.
UpdateMethodResult	withHttpMethod(String httpMethod) The HTTP method.
UpdateMethodResult	withMethodIntegration(Integration methodIntegration) The method's integration.
UpdateMethodResult	withMethodResponses(Map<String,MethodResponse> methodResponses) Represents available responses that can be sent to the caller.
UpdateMethodResult	withRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
UpdateMethodResult	withRequestParameters(Map<String,Boolean> requestParameters) Represents request parameters that can be accepted by Amazon API Gateway.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateMethodResult

public UpdateMethodResult()

Method Detail

setHttpMethod

public void setHttpMethod(String httpMethod)

The HTTP method.

Parameters:

httpMethod - The HTTP method.

getHttpMethod

public String getHttpMethod()

The HTTP method.

Returns:

The HTTP method.

withHttpMethod

public UpdateMethodResult withHttpMethod(String httpMethod)

The HTTP method.

Parameters:

httpMethod - The HTTP method.

Returns:

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

setAuthorizationType

public void setAuthorizationType(String authorizationType)

The method's authorization type.

Parameters:

authorizationType - The method's authorization type.

getAuthorizationType

public String getAuthorizationType()

The method's authorization type.

Returns:

The method's authorization type.

withAuthorizationType

public UpdateMethodResult withAuthorizationType(String authorizationType)

The method's authorization type.

Parameters:

authorizationType - The method's authorization type.

Returns:

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

setAuthorizerId

public void setAuthorizerId(String authorizerId)

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

Parameters:

authorizerId - Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

getAuthorizerId

public String getAuthorizerId()

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

Returns:

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

withAuthorizerId

public UpdateMethodResult withAuthorizerId(String authorizerId)

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

Parameters:

authorizerId - Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

Returns:

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

setApiKeyRequired

public void setApiKeyRequired(Boolean apiKeyRequired)

Specifies whether the method requires a valid ApiKey.

Parameters:

apiKeyRequired - Specifies whether the method requires a valid ApiKey.

getApiKeyRequired

public Boolean getApiKeyRequired()

Specifies whether the method requires a valid ApiKey.

Returns:

Specifies whether the method requires a valid ApiKey.

withApiKeyRequired

public UpdateMethodResult withApiKeyRequired(Boolean apiKeyRequired)

Specifies whether the method requires a valid ApiKey.

Parameters:

apiKeyRequired - Specifies whether the method requires a valid ApiKey.

Returns:

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

isApiKeyRequired

public Boolean isApiKeyRequired()

Specifies whether the method requires a valid ApiKey.

Returns:

Specifies whether the method requires a valid ApiKey.

getRequestParameters

public Map<String,Boolean> getRequestParameters()

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

Returns:

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

setRequestParameters

public void setRequestParameters(Map<String,Boolean> requestParameters)

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

Parameters:

requestParameters - Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

withRequestParameters

public UpdateMethodResult withRequestParameters(Map<String,Boolean> requestParameters)

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

Parameters:

requestParameters - Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern method.request.{location}.{name}, where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

Returns:

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

addRequestParametersEntry

public UpdateMethodResult addRequestParametersEntry(String key,
                                           Boolean value)

clearRequestParametersEntries

public UpdateMethodResult clearRequestParametersEntries()

Removes all the entries added into RequestParameters. <p> Returns a reference to this object so that method calls can be chained together.

getRequestModels

public Map<String,String> getRequestModels()

Specifies the Model resources used for the request's content type. Request 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 request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

setRequestModels

public void setRequestModels(Map<String,String> requestModels)

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

Parameters:

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

withRequestModels

public UpdateMethodResult withRequestModels(Map<String,String> requestModels)

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

Parameters:

requestModels - Specifies the Model resources used for the request's content type. Request 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.

addRequestModelsEntry

public UpdateMethodResult addRequestModelsEntry(String key,
                                       String value)

clearRequestModelsEntries

public UpdateMethodResult clearRequestModelsEntries()

Removes all the entries added into RequestModels. <p> Returns a reference to this object so that method calls can be chained together.

getMethodResponses

public Map<String,MethodResponse> getMethodResponses()

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

Returns:

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

setMethodResponses

public void setMethodResponses(Map<String,MethodResponse> methodResponses)

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

Parameters:

methodResponses - Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

withMethodResponses

public UpdateMethodResult withMethodResponses(Map<String,MethodResponse> methodResponses)

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

Parameters:

methodResponses - Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

Returns:

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

addMethodResponsesEntry

public UpdateMethodResult addMethodResponsesEntry(String key,
                                         MethodResponse value)

clearMethodResponsesEntries

public UpdateMethodResult clearMethodResponsesEntries()

Removes all the entries added into MethodResponses. <p> Returns a reference to this object so that method calls can be chained together.

setMethodIntegration

public void setMethodIntegration(Integration methodIntegration)

The method's integration.

Parameters:

methodIntegration - The method's integration.

getMethodIntegration

public Integration getMethodIntegration()

The method's integration.

Returns:

The method's integration.

withMethodIntegration

public UpdateMethodResult withMethodIntegration(Integration methodIntegration)

The method's integration.

Parameters:

methodIntegration - The method's integration.

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; useful for testing and debugging.

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 UpdateMethodResult clone()

Overrides:

clone in class Object