software.amazon.awssdk.services.apigateway.model

Interface PutMethodResponseRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>, SdkBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutMethodResponseRequest

public static interface PutMethodResponseRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<PutMethodResponseRequest.Builder,PutMethodResponseRequest>

Method Summary

Modifier and Type	Method and Description
PutMethodResponseRequest.Builder	httpMethod(String httpMethod) [Required] The HTTP verb of the Method resource.
PutMethodResponseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutMethodResponseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutMethodResponseRequest.Builder	resourceId(String resourceId) [Required] The Resource identifier for the Method resource.
PutMethodResponseRequest.Builder	responseModels(Map<String,String> responseModels) Specifies the Model resources used for the response's content type.
PutMethodResponseRequest.Builder	responseParameters(Map<String,Boolean> responseParameters) A key-value map specifying required or optional response parameters that API Gateway can send back to the caller.
PutMethodResponseRequest.Builder	restApiId(String restApiId) [Required] The string identifier of the associated RestApi.
PutMethodResponseRequest.Builder	statusCode(String statusCode) [Required] The method response's status code.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

restApiId

PutMethodResponseRequest.Builder restApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

Returns:

Returns a reference to this object so that method calls can be chained together.

resourceId

PutMethodResponseRequest.Builder resourceId(String resourceId)

[Required] The Resource identifier for the Method resource.

Parameters:

resourceId - [Required] The Resource identifier for the Method resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

httpMethod

PutMethodResponseRequest.Builder httpMethod(String httpMethod)

[Required] The HTTP verb of the Method resource.

Parameters:

httpMethod - [Required] The HTTP verb of the Method resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusCode

PutMethodResponseRequest.Builder statusCode(String statusCode)

[Required] The method response's status code.

Parameters:

statusCode - [Required] The method response's status code.

Returns:

Returns a reference to this object so that method calls can be chained together.

responseParameters

PutMethodResponseRequest.Builder responseParameters(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.)

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

responseModels

PutMethodResponseRequest.Builder responseModels(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.

overrideConfiguration

PutMethodResponseRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PutMethodResponseRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.