software.amazon.awssdk.services.apigateway.model

Interface PutGatewayResponseRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>, SdkBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>, SdkRequest.Builder

Enclosing class:

PutGatewayResponseRequest

public static interface PutGatewayResponseRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<PutGatewayResponseRequest.Builder,PutGatewayResponseRequest>

Method Summary

Modifier and Type	Method and Description
PutGatewayResponseRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
PutGatewayResponseRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
PutGatewayResponseRequest.Builder	responseParameters(Map<String,String> responseParameters)
PutGatewayResponseRequest.Builder	responseTemplates(Map<String,String> responseTemplates)
PutGatewayResponseRequest.Builder	responseType(GatewayResponseType responseType)
PutGatewayResponseRequest.Builder	responseType(String responseType)
PutGatewayResponseRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.
PutGatewayResponseRequest.Builder	statusCode(String statusCode) The HTTP status code of the GatewayResponse.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

restApiId

PutGatewayResponseRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

responseType

PutGatewayResponseRequest.Builder responseType(String responseType)

The response type of the associated GatewayResponse. Valid values are

• ACCESS_DENIED
• API_CONFIGURATION_ERROR
• AUTHORIZER_FAILURE
• AUTHORIZER_CONFIGURATION_ERROR
• BAD_REQUEST_PARAMETERS
• BAD_REQUEST_BODY
• DEFAULT_4XX
• DEFAULT_5XX
• EXPIRED_TOKEN
• INVALID_SIGNATURE
• INTEGRATION_FAILURE
• INTEGRATION_TIMEOUT
• INVALID_API_KEY
• MISSING_AUTHENTICATION_TOKEN
• QUOTA_EXCEEDED
• REQUEST_TOO_LARGE
• RESOURCE_NOT_FOUND
• THROTTLED
• UNAUTHORIZED
• UNSUPPORTED_MEDIA_TYPES

Parameters:

responseType - The response type of the associated GatewayResponse. Valid values are

• ACCESS_DENIED
• API_CONFIGURATION_ERROR
• AUTHORIZER_FAILURE
• AUTHORIZER_CONFIGURATION_ERROR
• BAD_REQUEST_PARAMETERS
• BAD_REQUEST_BODY
• DEFAULT_4XX
• DEFAULT_5XX
• EXPIRED_TOKEN
• INVALID_SIGNATURE
• INTEGRATION_FAILURE
• INTEGRATION_TIMEOUT
• INVALID_API_KEY
• MISSING_AUTHENTICATION_TOKEN
• QUOTA_EXCEEDED
• REQUEST_TOO_LARGE
• RESOURCE_NOT_FOUND
• THROTTLED
• UNAUTHORIZED
• UNSUPPORTED_MEDIA_TYPES

Returns:

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

See Also:

GatewayResponseType, GatewayResponseType

responseType

PutGatewayResponseRequest.Builder responseType(GatewayResponseType responseType)

The response type of the associated GatewayResponse. Valid values are

• ACCESS_DENIED
• API_CONFIGURATION_ERROR
• AUTHORIZER_FAILURE
• AUTHORIZER_CONFIGURATION_ERROR
• BAD_REQUEST_PARAMETERS
• BAD_REQUEST_BODY
• DEFAULT_4XX
• DEFAULT_5XX
• EXPIRED_TOKEN
• INVALID_SIGNATURE
• INTEGRATION_FAILURE
• INTEGRATION_TIMEOUT
• INVALID_API_KEY
• MISSING_AUTHENTICATION_TOKEN
• QUOTA_EXCEEDED
• REQUEST_TOO_LARGE
• RESOURCE_NOT_FOUND
• THROTTLED
• UNAUTHORIZED
• UNSUPPORTED_MEDIA_TYPES

Parameters:

responseType - The response type of the associated GatewayResponse. Valid values are

• ACCESS_DENIED
• API_CONFIGURATION_ERROR
• AUTHORIZER_FAILURE
• AUTHORIZER_CONFIGURATION_ERROR
• BAD_REQUEST_PARAMETERS
• BAD_REQUEST_BODY
• DEFAULT_4XX
• DEFAULT_5XX
• EXPIRED_TOKEN
• INVALID_SIGNATURE
• INTEGRATION_FAILURE
• INTEGRATION_TIMEOUT
• INVALID_API_KEY
• MISSING_AUTHENTICATION_TOKEN
• QUOTA_EXCEEDED
• REQUEST_TOO_LARGE
• RESOURCE_NOT_FOUND
• THROTTLED
• UNAUTHORIZED
• UNSUPPORTED_MEDIA_TYPES

Returns:

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

See Also:

GatewayResponseType, GatewayResponseType

statusCode

PutGatewayResponseRequest.Builder statusCode(String statusCode)

The HTTP status code of the GatewayResponse.

Parameters:

statusCode - The HTTP status code of the GatewayResponse.

Returns:

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

responseParameters

PutGatewayResponseRequest.Builder responseParameters(Map<String,String> responseParameters)

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Returns:

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

responseTemplates

PutGatewayResponseRequest.Builder responseTemplates(Map<String,String> responseTemplates)

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Parameters:

responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

Returns:

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

requestOverrideConfig

PutGatewayResponseRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

PutGatewayResponseRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.