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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResponseModels() Returns true if the ResponseModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasResponseParameters() Returns true if the ResponseParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

restApiId

public final String restApiId()

[Required] The string identifier of the associated RestApi.

Returns:

[Required] The string identifier of the associated RestApi.

resourceId

public final String resourceId()

[Required] The Resource identifier for the Method resource.

Returns:

[Required] The Resource identifier for the Method resource.

httpMethod

public final String httpMethod()

[Required] The HTTP verb of the Method resource.

Returns:

[Required] The HTTP verb of the Method resource.

statusCode

public final String statusCode()

[Required] The method response's status code.

Returns:

[Required] The method response's status code.

hasResponseParameters

public final boolean hasResponseParameters()

Returns true if the ResponseParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

responseParameters

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

You can use hasResponseParameters() to see if a value was sent in this field.

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

hasResponseModels

public final boolean hasResponseModels()

Returns true if the ResponseModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

responseModels

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

You can use hasResponseModels() to see if a value was sent in this field.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static PutMethodResponseRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo