software.amazon.awssdk.services.apigateway.model

Class PutMethodResponseRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

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

Request to add a MethodResponse to an existing Method resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutMethodResponseRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutMethodResponseRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	httpMethod() [Required] The HTTP verb of the Method resource.
String	resourceId() [Required] 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 API Gateway can send back to the caller.
String	restApiId() [Required] The string identifier of the associated RestApi.
List<SdkField<?>>	sdkFields()
static Class<? extends PutMethodResponseRequest.Builder>	serializableBuilderClass()
String	statusCode() [Required] 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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

restApiId

public String restApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

resourceId

public String resourceId()

[Required] The Resource identifier for the Method resource.

Returns:

[Required] The Resource identifier for the Method resource.

httpMethod

public String httpMethod()

[Required] The HTTP verb of the Method resource.

Returns:

[Required] The HTTP verb of the Method resource.

statusCode

public String statusCode()

[Required] The method response's status code.

Returns:

[Required] The method response's status code.

responseParameters

public Map<String,Boolean> responseParameters()

A key-value map specifying required or optional response parameters that 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.)

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A key-value map specifying required or optional response parameters that 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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>

Specified by:

toBuilder in class ApiGatewayRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.