Package software.amazon.awssdk.http

Interface SdkHttpFullRequest.Builder

All Superinterfaces:

CopyableBuilder<SdkHttpFullRequest.Builder,SdkHttpFullRequest>, SdkBuilder<SdkHttpFullRequest.Builder,SdkHttpFullRequest>, SdkHttpHeaders, SdkHttpRequest

All Known Implementing Classes:

DefaultSdkHttpFullRequest.Builder

Enclosing interface:

SdkHttpFullRequest

public static interface SdkHttpFullRequest.Builder
extends CopyableBuilder<SdkHttpFullRequest.Builder,SdkHttpFullRequest>, SdkHttpRequest

Builder interface for SdkHttpFullRequest.

Method Summary

Modifier and Type	Method	Description
SdkHttpFullRequest.Builder	clearQueryParameters()	Removes all query parameters from the builder.
SdkHttpFullRequest.Builder	content(InputStream content)	Sets the HTTP content for the builder.
SdkHttpFullRequest.Builder	endpoint(URI endpoint)	Sets the endpoint for the builder.
InputStream	getContent()	Returns the optional stream containing the payload data to include for this request.
<T> SdkHttpFullRequest.Builder	handlerContext(HandlerContextKey<T> key, T value)	Adds to the handler context for the builder.
default SdkHttpFullRequest.Builder	header(String key, String value)	Adds the header to the builder.
SdkHttpFullRequest.Builder	header(String key, List<String> values)	Adds the header values to the builder.
SdkHttpFullRequest.Builder	headers(Map<String,List<String>> headers)	Adds the headers to the builder.
SdkHttpFullRequest.Builder	httpMethod(SdkHttpMethod httpMethod)	Sets the SdkHttpMethod for the builder.
default SdkHttpFullRequest.Builder	queryParameter(String paramName, String paramValue)	Adds the query parameter to the builder.
SdkHttpFullRequest.Builder	queryParameter(String paramName, List<String> paramValues)	Adds the query parameter with multiple values to the builder.
SdkHttpFullRequest.Builder	queryParameters(Map<String,List<String>> queryParameters)	Adds the query parameters to the builder.
SdkHttpFullRequest.Builder	removeQueryParameter(String paramName)	Removes all values for the query paramter from the builder.
SdkHttpFullRequest.Builder	resourcePath(String resourcePath)	Sets the resource path on the builder.

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

copy

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

apply, build

Methods inherited from interface software.amazon.awssdk.http.SdkHttpHeaders

getFirstHeaderValue, getHeaders, getValuesForHeader

Methods inherited from interface software.amazon.awssdk.http.SdkHttpRequest

getEndpoint, getHttpMethod, getParameters, getResourcePath, handlerContext

Method Detail

header

default SdkHttpFullRequest.Builder header(String key,
                                          String value)

Adds the header to the builder.

>Note that this does not merge with any values that may be pre-existing for that header, it does a complete overwrite of this header key. Merging must be handled by the caller if desired.

Parameters:

key - Header name

value - Header value

Returns:

This builder for method chaining.

header

SdkHttpFullRequest.Builder header(String key,
                                  List<String> values)

Adds the header values to the builder.

>Note that this does not merge with any values that may be pre-existing for that header, it does a complete overwrite of this header key. Merging must be handled by the caller if desired.

Parameters:

key - Header name

values - List of values associated with this header key.

Returns:

This builder for method chaining.

headers

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

Adds the headers to the builder.

>Note that this does not merge with any values that may be pre-existing for that header, it does a complete overwrite of each header key in the map. Merging must be handled by the caller if desired.

Parameters:

headers - Headers to add

Returns:

This builder for method chaining.

resourcePath

SdkHttpFullRequest.Builder resourcePath(String resourcePath)

Sets the resource path on the builder.

Parameters:

resourcePath - New resource path.

Returns:

This builder for method chaining.

queryParameter

default SdkHttpFullRequest.Builder queryParameter(String paramName,
                                                  String paramValue)

Adds the query parameter to the builder.

>Note that this does not merge with any values that may be pre-existing for that parameter, it does a complete overwrite of the parameter. Merging must be handled by the caller if desired.

Parameters:

paramName - Name of the parameter to add

paramValue - Value for the query param.

Returns:

This builder for method chaining.

queryParameter

SdkHttpFullRequest.Builder queryParameter(String paramName,
                                          List<String> paramValues)

Adds the query parameter with multiple values to the builder.

>Note that this does not merge with any values that may be pre-existing for that parameter, it does a complete overwrite of the parameter. Merging must be handled by the caller if desired.

Parameters:

paramName - Name of the parameter to add

paramValues - List of values associated with this query parameter.

Returns:

This builder for method chaining.

queryParameters

SdkHttpFullRequest.Builder queryParameters(Map<String,List<String>> queryParameters)

Adds the query parameters to the builder.

>Note that this does not merge with any values that may be pre-existing, it does a complete overwrite of each query parameter in the map. Merging must be handled by the caller if desired.

Parameters:

queryParameters - Query parameters to add

Returns:

This builder for method chaining.

removeQueryParameter

SdkHttpFullRequest.Builder removeQueryParameter(String paramName)

Removes all values for the query paramter from the builder.

Parameters:

paramName - Query param to remove.

Returns:

This builder for method chaining.

clearQueryParameters

SdkHttpFullRequest.Builder clearQueryParameters()

Removes all query parameters from the builder.

Returns:

This builder for method chaining.

endpoint

SdkHttpFullRequest.Builder endpoint(URI endpoint)

Sets the endpoint for the builder.

Parameters:

endpoint - New endpoint.

Returns:

This builder for method chaining.

httpMethod

SdkHttpFullRequest.Builder httpMethod(SdkHttpMethod httpMethod)

Sets the SdkHttpMethod for the builder.

Parameters:

httpMethod - New HTTP method.

Returns:

This builder for method chaining.

content

SdkHttpFullRequest.Builder content(InputStream content)

Sets the HTTP content for the builder.

Parameters:

content - New content.

Returns:

This builder for method chaining.

getContent

InputStream getContent()

Returns the optional stream containing the payload data to include for this request.
Not all requests will contain payload data.

Returns:

The optional stream containing the payload data to include for this request or null if there is no payload.

handlerContext

<T> SdkHttpFullRequest.Builder handlerContext(HandlerContextKey<T> key,
                                              T value)

Adds to the handler context for the builder.

Parameters:

key - Key to add context under.

value - Value associated with key.

Returns:

This builder for method chaining.