public class PutMethodResponseRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Request to add a MethodResponse to an existing Method resource.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
httpMethod
The HTTP verb that identifies the Method resource.
|
private java.lang.String |
resourceId
|
private java.util.Map<java.lang.String,java.lang.String> |
responseModels
Specifies the Model resources used for the response's content
type.
|
private java.util.Map<java.lang.String,java.lang.Boolean> |
responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway.
|
private java.lang.String |
restApiId
|
private java.lang.String |
statusCode
The method response's status code.
|
NOOP
Constructor and Description |
---|
PutMethodResponseRequest() |
Modifier and Type | Method and Description |
---|---|
PutMethodResponseRequest |
addResponseModelsEntry(java.lang.String key,
java.lang.String value) |
PutMethodResponseRequest |
addResponseParametersEntry(java.lang.String key,
java.lang.Boolean value) |
PutMethodResponseRequest |
clearResponseModelsEntries()
Removes all the entries added into ResponseModels.
|
PutMethodResponseRequest |
clearResponseParametersEntries()
Removes all the entries added into ResponseParameters.
|
PutMethodResponseRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getHttpMethod()
The HTTP verb that identifies the Method resource.
|
java.lang.String |
getResourceId()
|
java.util.Map<java.lang.String,java.lang.String> |
getResponseModels()
Specifies the Model resources used for the response's content
type.
|
java.util.Map<java.lang.String,java.lang.Boolean> |
getResponseParameters()
Represents response parameters that can be sent back to the caller by
Amazon API Gateway.
|
java.lang.String |
getRestApiId()
|
java.lang.String |
getStatusCode()
The method response's status code.
|
int |
hashCode() |
void |
setHttpMethod(java.lang.String httpMethod)
The HTTP verb that identifies the Method resource.
|
void |
setResourceId(java.lang.String resourceId)
|
void |
setResponseModels(java.util.Map<java.lang.String,java.lang.String> responseModels)
Specifies the Model resources used for the response's content
type.
|
void |
setResponseParameters(java.util.Map<java.lang.String,java.lang.Boolean> responseParameters)
Represents response parameters that can be sent back to the caller by
Amazon API Gateway.
|
void |
setRestApiId(java.lang.String restApiId)
|
void |
setStatusCode(java.lang.String statusCode)
The method response's status code.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutMethodResponseRequest |
withHttpMethod(java.lang.String httpMethod)
The HTTP verb that identifies the Method resource.
|
PutMethodResponseRequest |
withResourceId(java.lang.String resourceId)
|
PutMethodResponseRequest |
withResponseModels(java.util.Map<java.lang.String,java.lang.String> responseModels)
Specifies the Model resources used for the response's content
type.
|
PutMethodResponseRequest |
withResponseParameters(java.util.Map<java.lang.String,java.lang.Boolean> responseParameters)
Represents response parameters that can be sent back to the caller by
Amazon API Gateway.
|
PutMethodResponseRequest |
withRestApiId(java.lang.String restApiId)
|
PutMethodResponseRequest |
withStatusCode(java.lang.String statusCode)
The method response's status code.
|
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
The HTTP verb that identifies the Method resource.
private java.lang.String statusCode
The method response's status code.
private java.util.Map<java.lang.String,java.lang.Boolean> responseParameters
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}
, where name
is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
private java.util.Map<java.lang.String,java.lang.String> responseModels
public void setRestApiId(java.lang.String restApiId)
public java.lang.String getRestApiId()
public PutMethodResponseRequest withRestApiId(java.lang.String restApiId)
public void setResourceId(java.lang.String resourceId)
public java.lang.String getResourceId()
public PutMethodResponseRequest withResourceId(java.lang.String resourceId)
public void setHttpMethod(java.lang.String httpMethod)
The HTTP verb that identifies the Method resource.
httpMethod
- The HTTP verb that identifies the Method resource.public java.lang.String getHttpMethod()
The HTTP verb that identifies the Method resource.
public PutMethodResponseRequest withHttpMethod(java.lang.String httpMethod)
The HTTP verb that identifies the Method resource.
httpMethod
- The HTTP verb that identifies the Method resource.public void setStatusCode(java.lang.String statusCode)
The method response's status code.
statusCode
- The method response's status code.public java.lang.String getStatusCode()
The method response's status code.
public PutMethodResponseRequest withStatusCode(java.lang.String statusCode)
The method response's status code.
statusCode
- The method response's status code.public java.util.Map<java.lang.String,java.lang.Boolean> getResponseParameters()
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}
, where name
is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
method.response.header.{name}
, where
name
is a valid, unique header name. Destinations
specified here are available to the integration for mapping from
integration response parameters.public void setResponseParameters(java.util.Map<java.lang.String,java.lang.Boolean> responseParameters)
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}
, where name
is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
responseParameters
- Represents response parameters that can be sent back to the caller
by Amazon API Gateway. Response parameters are represented as a
key/value map, with a destination as the key and a Boolean flag as
the value. The Boolean flag is used to specify whether the
parameter is required. A destination must match the pattern
method.response.header.{name}
, where
name
is a valid, unique header name. Destinations
specified here are available to the integration for mapping from
integration response parameters.public PutMethodResponseRequest withResponseParameters(java.util.Map<java.lang.String,java.lang.Boolean> responseParameters)
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a Boolean flag as the value. The
Boolean flag is used to specify whether the parameter is required. A
destination must match the pattern
method.response.header.{name}
, where name
is a
valid, unique header name. Destinations specified here are available to
the integration for mapping from integration response parameters.
responseParameters
- Represents response parameters that can be sent back to the caller
by Amazon API Gateway. Response parameters are represented as a
key/value map, with a destination as the key and a Boolean flag as
the value. The Boolean flag is used to specify whether the
parameter is required. A destination must match the pattern
method.response.header.{name}
, where
name
is a valid, unique header name. Destinations
specified here are available to the integration for mapping from
integration response parameters.public PutMethodResponseRequest addResponseParametersEntry(java.lang.String key, java.lang.Boolean value)
public PutMethodResponseRequest clearResponseParametersEntries()
public java.util.Map<java.lang.String,java.lang.String> getResponseModels()
public void setResponseModels(java.util.Map<java.lang.String,java.lang.String> responseModels)
public PutMethodResponseRequest withResponseModels(java.util.Map<java.lang.String,java.lang.String> responseModels)
Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
responseModels
- Specifies the Model resources used for the response's
content type. Response models are represented as a key/value map,
with a content type as the key and a Model name as the
value.public PutMethodResponseRequest addResponseModelsEntry(java.lang.String key, java.lang.String value)
public PutMethodResponseRequest clearResponseModelsEntries()
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 PutMethodResponseRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()