software.amazon.awssdk.http

Interface SdkHttpFullResponse.Builder

All Superinterfaces:

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

Enclosing interface:

SdkHttpFullResponse

public static interface SdkHttpFullResponse.Builder
extends SdkHttpResponse.Builder

Builder for a DefaultSdkHttpFullResponse.

Method Summary

Modifier and Type	Method and Description
SdkHttpFullResponse.Builder	appendHeader(String headerName, String headerValue) Add a single header to be included in the created HTTP request.
SdkHttpFullResponse	build()
SdkHttpFullResponse.Builder	clearHeaders() Removes all headers from this builder.
AbortableInputStream	content() The content, exactly as it was configured with content(AbortableInputStream).
SdkHttpFullResponse.Builder	content(AbortableInputStream content) Configure an SdkHttpFullResponse.content() to be used in the HTTP response.
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).
SdkHttpFullResponse.Builder	headers(Map<String,List<String>> headers) Configure an SdkHttpHeaders.headers() to be used in the created HTTP response.
SdkHttpFullResponse.Builder	putHeader(String headerName, List<String> headerValues) Add a single header with multiple values to be included in the created HTTP response.
default SdkHttpFullResponse.Builder	putHeader(String headerName, String headerValue) Add a single header to be included in the created HTTP response.
SdkHttpFullResponse.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).
SdkHttpFullResponse.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).
SdkHttpFullResponse.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

Method Detail

statusText

String statusText()

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

Specified by:

statusText in interface SdkHttpResponse.Builder

statusText

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

Specified by:

statusText in interface SdkHttpResponse.Builder

statusCode

int statusCode()

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

Specified by:

statusCode in interface SdkHttpResponse.Builder

statusCode

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

Specified by:

statusCode in interface SdkHttpResponse.Builder

headers

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

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

Specified by:

headers in interface SdkHttpResponse.Builder

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)

.

Specified by:

firstMatchingHeader in interface SdkHttpResponse.Builder

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

Specified by:

putHeader in interface SdkHttpResponse.Builder

Parameters:

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

headerValue - The value for the header

putHeader

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

Specified by:

putHeader in interface SdkHttpResponse.Builder

Parameters:

headerName - The name of the header to add

headerValues - The values for the header

appendHeader

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

Specified by:

appendHeader in interface SdkHttpResponse.Builder

Parameters:

headerName - The name of the header to add

headerValue - The value for the header

headers

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

Specified by:

headers in interface SdkHttpResponse.Builder

removeHeader

SdkHttpFullResponse.Builder removeHeader(String headerName)

Remove all values for the requested header from this builder.

Specified by:

removeHeader in interface SdkHttpResponse.Builder

clearHeaders

SdkHttpFullResponse.Builder clearHeaders()

Removes all headers from this builder.

Specified by:

clearHeaders in interface SdkHttpResponse.Builder

content

AbortableInputStream content()

The content, exactly as it was configured with content(AbortableInputStream).

content

SdkHttpFullResponse.Builder content(AbortableInputStream content)

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

Implementers should implement the abort method on the input stream to drop all remaining content with the service. This is usually done by closing the service connection.

build

SdkHttpFullResponse build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<SdkHttpResponse.Builder,SdkHttpResponse>