com.amazonaws.services.apigateway.model

Class PutMethodRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutMethodRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Request to add a method to an existing Resource resource.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutMethodRequest()

Method Summary

Modifier and Type	Method and Description
PutMethodRequest	addRequestModelsEntry(String key, String value)
PutMethodRequest	addRequestParametersEntry(String key, Boolean value)
PutMethodRequest	clearRequestModelsEntries() Removes all the entries added into RequestModels.
PutMethodRequest	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
PutMethodRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getApiKeyRequired() Specifies whether the method required a valid ApiKey.
String	getAuthorizationType() The method's authorization type.
String	getAuthorizerId() Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
String	getHttpMethod() Specifies the method request's HTTP method type.
String	getOperationName() A human-friendly operation identifier for the method.
Map<String,String>	getRequestModels() Specifies the Model resources used for the request's content type.
Map<String,Boolean>	getRequestParameters() A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway.
String	getRequestValidatorId() The identifier of a RequestValidator for validating the method request.
String	getResourceId() The Resource identifier for the new Method resource.
String	getRestApiId() The string identifier of the associated RestApi.
int	hashCode()
Boolean	isApiKeyRequired() Specifies whether the method required a valid ApiKey.
void	setApiKeyRequired(Boolean apiKeyRequired) Specifies whether the method required 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, if the type is CUSTOM.
void	setHttpMethod(String httpMethod) Specifies the method request's HTTP method type.
void	setOperationName(String operationName) A human-friendly operation identifier for the method.
void	setRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
void	setRequestParameters(Map<String,Boolean> requestParameters) A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway.
void	setRequestValidatorId(String requestValidatorId) The identifier of a RequestValidator for validating the method request.
void	setResourceId(String resourceId) The Resource identifier for the new Method resource.
void	setRestApiId(String restApiId) The string identifier of the associated RestApi.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutMethodRequest	withApiKeyRequired(Boolean apiKeyRequired) Specifies whether the method required a valid ApiKey.
PutMethodRequest	withAuthorizationType(String authorizationType) The method's authorization type.
PutMethodRequest	withAuthorizerId(String authorizerId) Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
PutMethodRequest	withHttpMethod(String httpMethod) Specifies the method request's HTTP method type.
PutMethodRequest	withOperationName(String operationName) A human-friendly operation identifier for the method.
PutMethodRequest	withRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
PutMethodRequest	withRequestParameters(Map<String,Boolean> requestParameters) A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway.
PutMethodRequest	withRequestValidatorId(String requestValidatorId) The identifier of a RequestValidator for validating the method request.
PutMethodRequest	withResourceId(String resourceId) The Resource identifier for the new Method resource.
PutMethodRequest	withRestApiId(String restApiId) The string identifier of the associated RestApi.

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

PutMethodRequest

public PutMethodRequest()

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 PutMethodRequest 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 new Method resource.

Parameters:

resourceId - The Resource identifier for the new Method resource.

getResourceId

public String getResourceId()

The Resource identifier for the new Method resource.

Returns:

The Resource identifier for the new Method resource.

withResourceId

public PutMethodRequest withResourceId(String resourceId)

The Resource identifier for the new Method resource.

Parameters:

resourceId - The Resource identifier for the new Method resource.

Returns:

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

setHttpMethod

public void setHttpMethod(String httpMethod)

Specifies the method request's HTTP method type.

Parameters:

httpMethod - Specifies the method request's HTTP method type.

getHttpMethod

public String getHttpMethod()

Specifies the method request's HTTP method type.

Returns:

Specifies the method request's HTTP method type.

withHttpMethod

public PutMethodRequest withHttpMethod(String httpMethod)

Specifies the method request's HTTP method type.

Parameters:

httpMethod - Specifies the method request's HTTP method type.

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. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Parameters:

authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

getAuthorizationType

public String getAuthorizationType()

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Returns:

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

withAuthorizationType

public PutMethodRequest withAuthorizationType(String authorizationType)

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Parameters:

authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

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, if the type is CUSTOM.

Parameters:

authorizerId - Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

getAuthorizerId

public String getAuthorizerId()

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

Returns:

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

withAuthorizerId

public PutMethodRequest withAuthorizerId(String authorizerId)

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

Parameters:

authorizerId - Specifies the identifier of an Authorizer to use on this Method, if the type is 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 required a valid ApiKey.

Parameters:

apiKeyRequired - Specifies whether the method required a valid ApiKey.

getApiKeyRequired

public Boolean getApiKeyRequired()

Specifies whether the method required a valid ApiKey.

Returns:

Specifies whether the method required a valid ApiKey.

withApiKeyRequired

public PutMethodRequest withApiKeyRequired(Boolean apiKeyRequired)

Specifies whether the method required a valid ApiKey.

Parameters:

apiKeyRequired - Specifies whether the method required 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 required a valid ApiKey.

Returns:

Specifies whether the method required a valid ApiKey.

setOperationName

public void setOperationName(String operationName)

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

Parameters:

operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

getOperationName

public String getOperationName()

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

Returns:

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

withOperationName

public PutMethodRequest withOperationName(String operationName)

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

Parameters:

operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

Returns:

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

getRequestParameters

public Map<String,Boolean> getRequestParameters()

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Returns:

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

setRequestParameters

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

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Parameters:

requestParameters - A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

withRequestParameters

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

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Parameters:

requestParameters - A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Returns:

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

addRequestParametersEntry

public PutMethodRequest addRequestParametersEntry(String key,
                                                  Boolean value)

clearRequestParametersEntries

public PutMethodRequest clearRequestParametersEntries()

Removes all the entries added into RequestParameters.

Returns:

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 PutMethodRequest 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 PutMethodRequest addRequestModelsEntry(String key,
                                              String value)

clearRequestModelsEntries

public PutMethodRequest clearRequestModelsEntries()

Removes all the entries added into RequestModels.

Returns:

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

setRequestValidatorId

public void setRequestValidatorId(String requestValidatorId)

The identifier of a RequestValidator for validating the method request.

Parameters:

requestValidatorId - The identifier of a RequestValidator for validating the method request.

getRequestValidatorId

public String getRequestValidatorId()

The identifier of a RequestValidator for validating the method request.

Returns:

The identifier of a RequestValidator for validating the method request.

withRequestValidatorId

public PutMethodRequest withRequestValidatorId(String requestValidatorId)

The identifier of a RequestValidator for validating the method request.

Parameters:

requestValidatorId - The identifier of a RequestValidator for validating the method request.

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 PutMethodRequest 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()