software.amazon.awssdk.services.apigateway.model

Interface PutGatewayResponseResponse.Builder

All Superinterfaces:

ApiGatewayResponse.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<PutGatewayResponseResponse.Builder,PutGatewayResponseResponse>, SdkBuilder<PutGatewayResponseResponse.Builder,PutGatewayResponseResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

PutGatewayResponseResponse

public static interface PutGatewayResponseResponse.Builder
extends ApiGatewayResponse.Builder, SdkPojo, CopyableBuilder<PutGatewayResponseResponse.Builder,PutGatewayResponseResponse>

Method Summary

Modifier and Type	Method and Description
PutGatewayResponseResponse.Builder	defaultResponse(Boolean defaultResponse) A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false).
PutGatewayResponseResponse.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.
PutGatewayResponseResponse.Builder	responseTemplates(Map<String,String> responseTemplates) Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
PutGatewayResponseResponse.Builder	responseType(GatewayResponseType responseType) The response type of the associated GatewayResponse.
PutGatewayResponseResponse.Builder	responseType(String responseType) The response type of the associated GatewayResponse.
PutGatewayResponseResponse.Builder	statusCode(String statusCode) The HTTP status code for this GatewayResponse.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

responseType

PutGatewayResponseResponse.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_TYPE

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_TYPE

Returns:

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

See Also:

GatewayResponseType, GatewayResponseType

responseType

PutGatewayResponseResponse.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_TYPE

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_TYPE

Returns:

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

See Also:

GatewayResponseType, GatewayResponseType

statusCode

PutGatewayResponseResponse.Builder statusCode(String statusCode)

The HTTP status code for this GatewayResponse.

Parameters:

statusCode - The HTTP status code for this GatewayResponse.

Returns:

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

responseParameters

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

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

defaultResponse

PutGatewayResponseResponse.Builder defaultResponse(Boolean defaultResponse)

A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

Parameters:

defaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

Returns:

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