com.amazonaws.services.apigateway.model

Class PutMethodRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigateway.model.PutMethodRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

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

Methods

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 request.
boolean	equals(Object obj)
Boolean	getApiKeyRequired() Specifies whether the method required a valid ApiKey.
String	getAuthorizationType() Specifies the type of authorization used for the method.
String	getHttpMethod() Specifies the put method request's HTTP method type.
Map<String,String>	getRequestModels() Specifies the Model resources used for the request's content type.
Map<String,Boolean>	getRequestParameters() Represents requests parameters that are sent with the backend request.
String	getResourceId() The Resource identifier for the new Method resource.
String	getRestApiId() The RestApi identifier for the new Method resource.
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) Specifies the type of authorization used for the method.
void	setHttpMethod(String httpMethod) Specifies the put method request's HTTP method type.
void	setRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
void	setRequestParameters(Map<String,Boolean> requestParameters) Represents requests parameters that are sent with the backend request.
void	setResourceId(String resourceId) The Resource identifier for the new Method resource.
void	setRestApiId(String restApiId) The RestApi identifier for the new Method resource.
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) Specifies the type of authorization used for the method.
PutMethodRequest	withHttpMethod(String httpMethod) Specifies the put method request's HTTP method type.
PutMethodRequest	withRequestModels(Map<String,String> requestModels) Specifies the Model resources used for the request's content type.
PutMethodRequest	withRequestParameters(Map<String,Boolean> requestParameters) Represents requests parameters that are sent with the backend request.
PutMethodRequest	withResourceId(String resourceId) The Resource identifier for the new Method resource.
PutMethodRequest	withRestApiId(String restApiId) The RestApi identifier for the new Method resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

PutMethodRequest

public PutMethodRequest()

Method Detail

setRestApiId

public void setRestApiId(String restApiId)

The RestApi identifier for the new Method resource.

Parameters:

restApiId - The RestApi identifier for the new Method resource.

getRestApiId

public String getRestApiId()

The RestApi identifier for the new Method resource.

Returns:

The RestApi identifier for the new Method resource.

withRestApiId

public PutMethodRequest withRestApiId(String restApiId)

The RestApi identifier for the new Method resource.

Parameters:

restApiId - The RestApi identifier for the new Method resource.

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 put method request's HTTP method type.

Parameters:

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

getHttpMethod

public String getHttpMethod()

Specifies the put method request's HTTP method type.

Returns:

Specifies the put method request's HTTP method type.

withHttpMethod

public PutMethodRequest withHttpMethod(String httpMethod)

Specifies the put method request's HTTP method type.

Parameters:

httpMethod - Specifies the put 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)

Specifies the type of authorization used for the method.

Parameters:

authorizationType - Specifies the type of authorization used for the method.

getAuthorizationType

public String getAuthorizationType()

Specifies the type of authorization used for the method.

Returns:

Specifies the type of authorization used for the method.

withAuthorizationType

public PutMethodRequest withAuthorizationType(String authorizationType)

Specifies the type of authorization used for the method.

Parameters:

authorizationType - Specifies the type of authorization used for the method.

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.

getRequestParameters

public Map<String,Boolean> getRequestParameters()

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

Returns:

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

setRequestParameters

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

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

Parameters:

requestParameters - Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

withRequestParameters

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

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

Parameters:

requestParameters - Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern integration.request.{location}.{name}, where location is either querystring, path, or header. name must be a valid, unique parameter name.

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. <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 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. <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 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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()