software.amazon.awssdk.http

Interface SdkHttpResponse.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SdkHttpResponse.Builder,SdkHttpResponse>, SdkBuilder<SdkHttpResponse.Builder,SdkHttpResponse>

All Known Subinterfaces:

SdkHttpFullResponse.Builder

Enclosing interface:

SdkHttpResponse

public static interface SdkHttpResponse.Builder
extends CopyableBuilder<SdkHttpResponse.Builder,SdkHttpResponse>

Builder for a DefaultSdkHttpFullResponse.

Method Summary

Modifier and Type	Method and Description
SdkHttpResponse.Builder	appendHeader(String headerName, String headerValue) Add a single header to be included in the created HTTP request.
SdkHttpResponse.Builder	clearHeaders() Removes all headers from this builder.
default Optional<String>	firstMatchingHeader(String header) Perform a case-insensitive search for a particular header in this request, returning the first matching header, if one is found.
Map<String,List<String>>	headers() The query parameters, exactly as they were configured with headers(Map), putHeader(String, String) and putHeader(String, List).
SdkHttpResponse.Builder	headers(Map<String,List<String>> headers) Configure an SdkHttpHeaders.headers() to be used in the created HTTP response.
SdkHttpResponse.Builder	putHeader(String headerName, List<String> headerValues) Add a single header with multiple values to be included in the created HTTP response.
default SdkHttpResponse.Builder	putHeader(String headerName, String headerValue) Add a single header to be included in the created HTTP response.
SdkHttpResponse.Builder	removeHeader(String headerName) Remove all values for the requested header from this builder.
int	statusCode() The status text, exactly as it was configured with statusCode(int).
SdkHttpResponse.Builder	statusCode(int statusCode) Configure an SdkHttpResponse.statusCode() to be used in the created HTTP response.
String	statusText() The status text, exactly as it was configured with statusText(String).
SdkHttpResponse.Builder	statusText(String statusText) Configure an SdkHttpResponse.statusText() to be used in the created HTTP response.

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

statusText

String statusText()

The status text, exactly as it was configured with statusText(String).

statusText

SdkHttpResponse.Builder statusText(String statusText)

Configure an SdkHttpResponse.statusText() to be used in the created HTTP response. This is not validated until the http response is created.

statusCode

int statusCode()

The status text, exactly as it was configured with statusCode(int).

statusCode

SdkHttpResponse.Builder statusCode(int statusCode)

Configure an SdkHttpResponse.statusCode() to be used in the created HTTP response. This is not validated until the http response is created.

headers

Map<String,List<String>> headers()

The query parameters, exactly as they were configured with headers(Map), putHeader(String, String) and putHeader(String, List).

firstMatchingHeader

default Optional<String> firstMatchingHeader(String header)

Perform a case-insensitive search for a particular header in this request, returning the first matching header, if one is found.

This is useful for headers like 'Content-Type' or 'Content-Length' of which there is expected to be only one value present.

This is equivalent to invoking SdkHttpUtils.firstMatchingHeader(Map, String)

.

Parameters:

header - The header to search for (case insensitively).

Returns:

The first header that matched the requested one, or empty if one was not found.

putHeader

default SdkHttpResponse.Builder putHeader(String headerName,
                                          String headerValue)

Add a single header to be included in the created HTTP response.

This completely OVERRIDES any values already configured with this header name in the builder.

Parameters:

headerName - The name of the header to add (eg. "Host")

headerValue - The value for the header

putHeader

SdkHttpResponse.Builder putHeader(String headerName,
                                  List<String> headerValues)

Add a single header with multiple values to be included in the created HTTP response.

This completely OVERRIDES any values already configured with this header name in the builder.

Parameters:

headerName - The name of the header to add

headerValues - The values for the header

appendHeader

SdkHttpResponse.Builder appendHeader(String headerName,
                                     String headerValue)

Add a single header to be included in the created HTTP request.

This will ADD the value to any existing values already configured with this header name in the builder.

Parameters:

headerName - The name of the header to add

headerValue - The value for the header

headers

SdkHttpResponse.Builder headers(Map<String,List<String>> headers)

Configure an SdkHttpHeaders.headers() to be used in the created HTTP response. This is not validated until the http response is created. This overrides any values currently configured in the builder.

removeHeader

SdkHttpResponse.Builder removeHeader(String headerName)

Remove all values for the requested header from this builder.

clearHeaders

SdkHttpResponse.Builder clearHeaders()

Removes all headers from this builder.