public class PutMethodRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Request to add a method to an existing Resource resource.
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
apiKeyRequired
Specifies whether the method required a valid ApiKey.
|
private java.lang.String |
authorizationType
Specifies the type of authorization used for the method.
|
private java.lang.String |
authorizerId
Specifies the identifier of an Authorizer to use on this Method,
if the type is CUSTOM.
|
private java.lang.String |
httpMethod
Specifies the put method request's HTTP method type.
|
private java.util.Map<java.lang.String,java.lang.String> |
requestModels
Specifies the Model resources used for the request's content type.
|
private java.util.Map<java.lang.String,java.lang.Boolean> |
requestParameters
Represents requests parameters that are sent with the backend request.
|
private java.lang.String |
resourceId
|
private java.lang.String |
restApiId
|
NOOP
Constructor and Description |
---|
PutMethodRequest() |
Modifier and Type | Method and Description |
---|---|
PutMethodRequest |
addRequestModelsEntry(java.lang.String key,
java.lang.String value) |
PutMethodRequest |
addRequestParametersEntry(java.lang.String key,
java.lang.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(java.lang.Object obj) |
java.lang.Boolean |
getApiKeyRequired()
Specifies whether the method required a valid ApiKey.
|
java.lang.String |
getAuthorizationType()
Specifies the type of authorization used for the method.
|
java.lang.String |
getAuthorizerId()
Specifies the identifier of an Authorizer to use on this Method,
if the type is CUSTOM.
|
java.lang.String |
getHttpMethod()
Specifies the put method request's HTTP method type.
|
java.util.Map<java.lang.String,java.lang.String> |
getRequestModels()
Specifies the Model resources used for the request's content type.
|
java.util.Map<java.lang.String,java.lang.Boolean> |
getRequestParameters()
Represents requests parameters that are sent with the backend request.
|
java.lang.String |
getResourceId()
|
java.lang.String |
getRestApiId()
|
int |
hashCode() |
java.lang.Boolean |
isApiKeyRequired()
Specifies whether the method required a valid ApiKey.
|
void |
setApiKeyRequired(java.lang.Boolean apiKeyRequired)
Specifies whether the method required a valid ApiKey.
|
void |
setAuthorizationType(java.lang.String authorizationType)
Specifies the type of authorization used for the method.
|
void |
setAuthorizerId(java.lang.String authorizerId)
Specifies the identifier of an Authorizer to use on this Method,
if the type is CUSTOM.
|
void |
setHttpMethod(java.lang.String httpMethod)
Specifies the put method request's HTTP method type.
|
void |
setRequestModels(java.util.Map<java.lang.String,java.lang.String> requestModels)
Specifies the Model resources used for the request's content type.
|
void |
setRequestParameters(java.util.Map<java.lang.String,java.lang.Boolean> requestParameters)
Represents requests parameters that are sent with the backend request.
|
void |
setResourceId(java.lang.String resourceId)
|
void |
setRestApiId(java.lang.String restApiId)
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutMethodRequest |
withApiKeyRequired(java.lang.Boolean apiKeyRequired)
Specifies whether the method required a valid ApiKey.
|
PutMethodRequest |
withAuthorizationType(java.lang.String authorizationType)
Specifies the type of authorization used for the method.
|
PutMethodRequest |
withAuthorizerId(java.lang.String authorizerId)
Specifies the identifier of an Authorizer to use on this Method,
if the type is CUSTOM.
|
PutMethodRequest |
withHttpMethod(java.lang.String httpMethod)
Specifies the put method request's HTTP method type.
|
PutMethodRequest |
withRequestModels(java.util.Map<java.lang.String,java.lang.String> requestModels)
Specifies the Model resources used for the request's content type.
|
PutMethodRequest |
withRequestParameters(java.util.Map<java.lang.String,java.lang.Boolean> requestParameters)
Represents requests parameters that are sent with the backend request.
|
PutMethodRequest |
withResourceId(java.lang.String resourceId)
|
PutMethodRequest |
withRestApiId(java.lang.String restApiId)
|
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
private java.lang.String restApiId
private java.lang.String resourceId
private java.lang.String httpMethod
Specifies the put method request's HTTP method type.
private java.lang.String authorizationType
Specifies the type of authorization used for the method.
private java.lang.String authorizerId
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
private java.lang.Boolean apiKeyRequired
Specifies whether the method required a valid ApiKey.
private java.util.Map<java.lang.String,java.lang.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.
private java.util.Map<java.lang.String,java.lang.String> requestModels
public void setRestApiId(java.lang.String restApiId)
public java.lang.String getRestApiId()
public PutMethodRequest withRestApiId(java.lang.String restApiId)
public void setResourceId(java.lang.String resourceId)
public java.lang.String getResourceId()
public PutMethodRequest withResourceId(java.lang.String resourceId)
public void setHttpMethod(java.lang.String httpMethod)
Specifies the put method request's HTTP method type.
httpMethod
- Specifies the put method request's HTTP method type.public java.lang.String getHttpMethod()
Specifies the put method request's HTTP method type.
public PutMethodRequest withHttpMethod(java.lang.String httpMethod)
Specifies the put method request's HTTP method type.
httpMethod
- Specifies the put method request's HTTP method type.public void setAuthorizationType(java.lang.String authorizationType)
Specifies the type of authorization used for the method.
authorizationType
- Specifies the type of authorization used for the method.public java.lang.String getAuthorizationType()
Specifies the type of authorization used for the method.
public PutMethodRequest withAuthorizationType(java.lang.String authorizationType)
Specifies the type of authorization used for the method.
authorizationType
- Specifies the type of authorization used for the method.public void setAuthorizerId(java.lang.String authorizerId)
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
authorizerId
- Specifies the identifier of an Authorizer to use on this
Method, if the type is CUSTOM.public java.lang.String getAuthorizerId()
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
public PutMethodRequest withAuthorizerId(java.lang.String authorizerId)
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
authorizerId
- Specifies the identifier of an Authorizer to use on this
Method, if the type is CUSTOM.public void setApiKeyRequired(java.lang.Boolean apiKeyRequired)
Specifies whether the method required a valid ApiKey.
apiKeyRequired
- Specifies whether the method required a valid ApiKey.public java.lang.Boolean getApiKeyRequired()
Specifies whether the method required a valid ApiKey.
public PutMethodRequest withApiKeyRequired(java.lang.Boolean apiKeyRequired)
Specifies whether the method required a valid ApiKey.
apiKeyRequired
- Specifies whether the method required a valid ApiKey.public java.lang.Boolean isApiKeyRequired()
Specifies whether the method required a valid ApiKey.
public java.util.Map<java.lang.String,java.lang.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.
integration.request.{location}.{name}
, where
location
is either querystring, path, or header.
name
must be a valid, unique parameter name.public void setRequestParameters(java.util.Map<java.lang.String,java.lang.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.
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.public PutMethodRequest withRequestParameters(java.util.Map<java.lang.String,java.lang.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.
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.public PutMethodRequest addRequestParametersEntry(java.lang.String key, java.lang.Boolean value)
public PutMethodRequest clearRequestParametersEntries()
public java.util.Map<java.lang.String,java.lang.String> getRequestModels()
public void setRequestModels(java.util.Map<java.lang.String,java.lang.String> requestModels)
public PutMethodRequest withRequestModels(java.util.Map<java.lang.String,java.lang.String> requestModels)
public PutMethodRequest addRequestModelsEntry(java.lang.String key, java.lang.String value)
public PutMethodRequest clearRequestModelsEntries()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public PutMethodRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()