Class PutMethodRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to add a method to an existing Resource resource.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddRequestModelsEntry
(String key, String value) addRequestParametersEntry
(String key, Boolean value) Removes all the entries added into RequestModels.Removes all the entries added into RequestParameters.clone()
Creates a shallow clone of this request.boolean
Specifies whether the method required a valid ApiKey.Specifies the type of authorization used for the method.Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.Specifies the put method request's HTTP method type.Specifies the Model resources used for the request's content type.Represents requests parameters that are sent with the backend request.int
hashCode()
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
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 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) void
setRestApiId
(String restApiId) toString()
Returns a string representation of this object; useful for testing and debugging.withApiKeyRequired
(Boolean apiKeyRequired) Specifies whether the method required a valid ApiKey.withAuthorizationType
(String authorizationType) Specifies the type of authorization used for the method.withAuthorizerId
(String authorizerId) Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.withHttpMethod
(String httpMethod) Specifies the put method request's HTTP method type.withRequestModels
(Map<String, String> requestModels) Specifies the Model resources used for the request's content type.withRequestParameters
(Map<String, Boolean> requestParameters) Represents requests parameters that are sent with the backend request.withResourceId
(String resourceId) withRestApiId
(String restApiId) 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
-
Constructor Details
-
PutMethodRequest
public PutMethodRequest()
-
-
Method Details
-
setRestApiId
-
getRestApiId
-
withRestApiId
-
setResourceId
-
getResourceId
-
withResourceId
-
setHttpMethod
Specifies the put method request's HTTP method type.
- Parameters:
httpMethod
- Specifies the put method request's HTTP method type.
-
getHttpMethod
Specifies the put method request's HTTP method type.
- Returns:
- Specifies the put method request's HTTP method type.
-
withHttpMethod
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
Specifies the type of authorization used for the method.
- Parameters:
authorizationType
- Specifies the type of authorization used for the method.
-
getAuthorizationType
Specifies the type of authorization used for the method.
- Returns:
- Specifies the type of authorization used for the method.
-
withAuthorizationType
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.
-
setAuthorizerId
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
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
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
Specifies whether the method required a valid ApiKey.
- Parameters:
apiKeyRequired
- Specifies whether the method required a valid ApiKey.
-
getApiKeyRequired
Specifies whether the method required a valid ApiKey.
- Returns:
- Specifies whether the method required a valid ApiKey.
-
withApiKeyRequired
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
Specifies whether the method required a valid ApiKey.
- Returns:
- Specifies whether the method required a valid ApiKey.
-
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}
, wherelocation
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}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.
-
setRequestParameters
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}
, wherelocation
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 patternintegration.request.{location}.{name}
, wherelocation
is either querystring, path, or header.name
must be a valid, unique parameter name.
-
withRequestParameters
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}
, wherelocation
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 patternintegration.request.{location}.{name}
, wherelocation
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
-
clearRequestParametersEntries
Removes all the entries added into RequestParameters. <p> Returns a reference to this object so that method calls can be chained together. -
getRequestModels
-
setRequestModels
-
withRequestModels
-
addRequestModelsEntry
-
clearRequestModelsEntries
Removes all the entries added into RequestModels. <p> Returns a reference to this object so that method calls can be chained together. -
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-