Package software.amazon.awssdk.services.apigateway.model

Class PutMethodResponseRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.PutMethodResponseRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

@Generated("software.amazon.awssdk:codegen")
public class PutMethodResponseRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

Request to add a MethodResponse to an existing Method resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutMethodResponseRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static PutMethodResponseRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	httpMethod()	The HTTP verb of the Method resource.
String	resourceId()	The Resource identifier for the Method resource.
Map<String,String>	responseModels()	Specifies the Model resources used for the response's content type.
Map<String,Boolean>	responseParameters()	A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller.
String	restApiId()	The RestApi identifier for the Method resource.
static Class<? extends PutMethodResponseRequest.Builder>	serializableBuilderClass()
String	statusCode()	The method response's status code.
PutMethodResponseRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

restApiId

public String restApiId()

The RestApi identifier for the Method resource.

Returns:

The RestApi identifier for the Method resource.

resourceId

public String resourceId()

The Resource identifier for the Method resource.

Returns:

The Resource identifier for the Method resource.

httpMethod

public String httpMethod()

The HTTP verb of the Method resource.

Returns:

The HTTP verb of the Method resource.

statusCode

public String statusCode()

The method response's status code.

Returns:

The method response's status code.

responseParameters

public Map<String,Boolean> responseParameters()

A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

Returns:

A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

responseModels

public 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.

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.

toBuilder

public PutMethodResponseRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

Returns:

a builder for type T

builder

public static PutMethodResponseRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutMethodResponseRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object