Class PutMethodResponseRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.apigateway.model.PutMethodResponseRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class PutMethodResponseRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Request to add a MethodResponse to an existing Method resource.

See Also:
  • Constructor Details

    • PutMethodResponseRequest

      public PutMethodResponseRequest()
  • Method Details

    • setRestApiId

      public void setRestApiId(String restApiId)

      The RestApi identifier for the Method resource.

      Parameters:
      restApiId - The RestApi identifier for the Method resource.
    • getRestApiId

      public String getRestApiId()

      The RestApi identifier for the Method resource.

      Returns:
      The RestApi identifier for the Method resource.
    • withRestApiId

      public PutMethodResponseRequest withRestApiId(String restApiId)

      The RestApi identifier for the Method resource.

      Parameters:
      restApiId - The RestApi identifier for the 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 Method resource.

      Parameters:
      resourceId - The Resource identifier for the Method resource.
    • getResourceId

      public String getResourceId()

      The Resource identifier for the Method resource.

      Returns:
      The Resource identifier for the Method resource.
    • withResourceId

      public PutMethodResponseRequest withResourceId(String resourceId)

      The Resource identifier for the Method resource.

      Parameters:
      resourceId - The Resource identifier for the Method resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setHttpMethod

      public void setHttpMethod(String httpMethod)

      The HTTP verb that identifies the Method resource.

      Parameters:
      httpMethod - The HTTP verb that identifies the Method resource.
    • getHttpMethod

      public String getHttpMethod()

      The HTTP verb that identifies the Method resource.

      Returns:
      The HTTP verb that identifies the Method resource.
    • withHttpMethod

      public PutMethodResponseRequest withHttpMethod(String httpMethod)

      The HTTP verb that identifies the Method resource.

      Parameters:
      httpMethod - The HTTP verb that identifies the Method resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatusCode

      public void setStatusCode(String statusCode)

      The method response's status code.

      Parameters:
      statusCode - The method response's status code.
    • getStatusCode

      public String getStatusCode()

      The method response's status code.

      Returns:
      The method response's status code.
    • withStatusCode

      public PutMethodResponseRequest withStatusCode(String statusCode)

      The method response's status code.

      Parameters:
      statusCode - The method response's status code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getResponseParameters

      public Map<String,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.

      Returns:
      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.
    • setResponseParameters

      public void setResponseParameters(Map<String,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.

      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.
    • withResponseParameters

      public PutMethodResponseRequest withResponseParameters(Map<String,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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addResponseParametersEntry

      public PutMethodResponseRequest addResponseParametersEntry(String key, Boolean value)
    • clearResponseParametersEntries

      public PutMethodResponseRequest clearResponseParametersEntries()
      Removes all the entries added into ResponseParameters. <p> Returns a reference to this object so that method calls can be chained together.
    • getResponseModels

      public Map<String,String> getResponseModels()

      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.

      Returns:
      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.
    • setResponseModels

      public void setResponseModels(Map<String,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.

      Parameters:
      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.
    • withResponseModels

      public PutMethodResponseRequest withResponseModels(Map<String,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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • addResponseModelsEntry

      public PutMethodResponseRequest addResponseModelsEntry(String key, String value)
    • clearResponseModelsEntries

      public PutMethodResponseRequest clearResponseModelsEntries()
      Removes all the entries added into ResponseModels. <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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public PutMethodResponseRequest 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: