software.amazon.awssdk.services.apigateway.model

Interface PutGatewayResponseRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutGatewayResponseRequest

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

Method Summary

Modifier and Type	Method and Description
PutGatewayResponseRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutGatewayResponseRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.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) [Required]
PutGatewayResponseRequest.Builder	responseType(String responseType) [Required]
PutGatewayResponseRequest.Builder	restApiId(String restApiId) [Required] 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

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

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

responseType

PutGatewayResponseRequest.Builder responseType(String responseType)

[Required]

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_TYPE

Parameters:

responseType - [Required]

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_TYPE

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)

[Required]

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_TYPE

Parameters:

responseType - [Required]

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_TYPE

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.

overrideConfiguration

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

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