Package software.amazon.awssdk.http

Interface SdkHttpFullRequest.Builder

All Superinterfaces:

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

Enclosing interface:

SdkHttpFullRequest

public static interface SdkHttpFullRequest.Builder
extends SdkHttpRequest.Builder

A mutable builder for SdkHttpFullRequest. An instance of this can be created using SdkHttpFullRequest.builder().

Method Summary

Modifier and Type	Method	Description
SdkHttpFullRequest.Builder	appendHeader(String headerName, String headerValue)	Add a single header to be included in the created HTTP request.
SdkHttpFullRequest.Builder	appendRawQueryParameter(String paramName, String paramValue)	Add a single un-encoded query parameter to be included in the created HTTP request.
SdkHttpFullRequest.Builder	applyMutation(Consumer<SdkHttpRequest.Builder> mutator)	A convenience operator that takes something that will mutate the builder in some way and allows inclusion of it in chaining operations.
SdkHttpFullRequest	build()	An immutable object that is created from the properties that have been set on the builder.
SdkHttpFullRequest.Builder	clearHeaders()	Removes all headers from this builder.
SdkHttpFullRequest.Builder	clearQueryParameters()	Removes all query parameters from this builder.
ContentStreamProvider	contentStreamProvider()
SdkHttpFullRequest.Builder	contentStreamProvider(ContentStreamProvider contentStreamProvider)	Set the ContentStreamProvider for this request.
SdkHttpFullRequest.Builder	copy()	A shallow copy of this object created by building an immutable T and then transforming it back to a builder.
String	encodedPath()	The path, exactly as it was configured with encodedPath(String).
SdkHttpFullRequest.Builder	encodedPath(String path)	Configure an SdkHttpRequest.encodedPath() to be used in the created HTTP request.
Map<String,List<String>>	headers()	The query parameters, exactly as they were configured with headers(Map), putHeader(String, String) and putHeader(String, List).
SdkHttpFullRequest.Builder	headers(Map<String,List<String>> headers)	Configure an SdkHttpHeaders.headers() to be used in the created HTTP request.
String	host()	The host, exactly as it was configured with host(String).
SdkHttpFullRequest.Builder	host(String host)	Configure a SdkHttpRequest.host() to be used in the created HTTP request.
SdkHttpMethod	method()	The path, exactly as it was configured with method(SdkHttpMethod).
SdkHttpFullRequest.Builder	method(SdkHttpMethod httpMethod)	Configure an SdkHttpRequest.method() to be used in the created HTTP request.
Integer	port()	The port, exactly as it was configured with port(Integer).
SdkHttpFullRequest.Builder	port(Integer port)	Configure a SdkHttpRequest.port() to be used in the created HTTP request.
String	protocol()	The protocol, exactly as it was configured with protocol(String).
SdkHttpFullRequest.Builder	protocol(String protocol)	Configure a SdkHttpRequest.protocol() to be used in the created HTTP request.
default SdkHttpFullRequest.Builder	putHeader(String headerName, String headerValue)	Add a single header to be included in the created HTTP request.
SdkHttpFullRequest.Builder	putHeader(String headerName, List<String> headerValues)	Add a single header with multiple values to be included in the created HTTP request.
default SdkHttpFullRequest.Builder	putRawQueryParameter(String paramName, String paramValue)	Add a single un-encoded query parameter to be included in the created HTTP request.
SdkHttpFullRequest.Builder	putRawQueryParameter(String paramName, List<String> paramValues)	Add a single un-encoded query parameter with multiple values to be included in the created HTTP request.
Map<String,List<String>>	rawQueryParameters()	The query parameters, exactly as they were configured with rawQueryParameters(Map), putRawQueryParameter(String, String) and putRawQueryParameter(String, List).
SdkHttpFullRequest.Builder	rawQueryParameters(Map<String,List<String>> queryParameters)	Configure an SdkHttpRequest.rawQueryParameters() to be used in the created HTTP request.
SdkHttpFullRequest.Builder	removeHeader(String headerName)	Remove all values for the requested header from this builder.
SdkHttpFullRequest.Builder	removeQueryParameter(String paramName)	Remove all values for the requested query parameter from this builder.
default SdkHttpFullRequest.Builder	uri(URI uri)	Convenience method to set the protocol(), host(), port(), encodedPath() and extracts query parameters from a URI object.

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

firstMatchingHeader, firstMatchingHeader, forEachHeader, matchingHeaders, numHeaders

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

encodedQueryParameters, forEachRawQueryParameter, numRawQueryParameters

Method Details

uri

default SdkHttpFullRequest.Builder uri(URI uri)

Convenience method to set the protocol(), host(), port(), encodedPath() and extracts query parameters from a URI object.

Specified by:

uri in interface SdkHttpRequest.Builder

Parameters:

uri - URI containing protocol, host, port and path.

Returns:

This builder for method chaining.

protocol

String protocol()

The protocol, exactly as it was configured with protocol(String).

Specified by:

protocol in interface SdkHttpRequest.Builder

protocol

SdkHttpFullRequest.Builder protocol(String protocol)

Configure a SdkHttpRequest.protocol() to be used in the created HTTP request. This is not validated until the http request is created.

Specified by:

protocol in interface SdkHttpRequest.Builder

host

String host()

The host, exactly as it was configured with host(String).

Specified by:

host in interface SdkHttpRequest.Builder

host

SdkHttpFullRequest.Builder host(String host)

Configure a SdkHttpRequest.host() to be used in the created HTTP request. This is not validated until the http request is created.

Specified by:

host in interface SdkHttpRequest.Builder

port

Integer port()

The port, exactly as it was configured with port(Integer).

Specified by:

port in interface SdkHttpRequest.Builder

port

SdkHttpFullRequest.Builder port(Integer port)

Configure a SdkHttpRequest.port() to be used in the created HTTP request. This is not validated until the http request is created. In order to simplify mapping from a URI, "-1" will be treated as "null" when the http request is created.

Specified by:

port in interface SdkHttpRequest.Builder

encodedPath

String encodedPath()

The path, exactly as it was configured with encodedPath(String).

Specified by:

encodedPath in interface SdkHttpRequest.Builder

encodedPath

SdkHttpFullRequest.Builder encodedPath(String path)

Configure an SdkHttpRequest.encodedPath() to be used in the created HTTP request. This is not validated until the http request is created. This path MUST be URL encoded.

Justification of requirements: The path must be encoded when it is configured, because there is no way for the HTTP implementation to distinguish a "/" that is part of a resource name that should be encoded as "%2F" from a "/" that is part of the actual path.

Specified by:

encodedPath in interface SdkHttpRequest.Builder

rawQueryParameters

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

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

Specified by:

rawQueryParameters in interface SdkHttpRequest.Builder

putRawQueryParameter

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

Add a single un-encoded query parameter to be included in the created HTTP request.

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

Specified by:

putRawQueryParameter in interface SdkHttpRequest.Builder

Parameters:

paramName - The name of the query parameter to add

paramValue - The un-encoded value for the query parameter.

appendRawQueryParameter

SdkHttpFullRequest.Builder appendRawQueryParameter(String paramName,
 String paramValue)

Add a single un-encoded query parameter to be included in the created HTTP request.

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

Specified by:

appendRawQueryParameter in interface SdkHttpRequest.Builder

Parameters:

paramName - The name of the query parameter to add

paramValue - The un-encoded value for the query parameter.

putRawQueryParameter

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

Add a single un-encoded query parameter with multiple values to be included in the created HTTP request.

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

Specified by:

putRawQueryParameter in interface SdkHttpRequest.Builder

Parameters:

paramName - The name of the query parameter to add

paramValues - The un-encoded values for the query parameter.

rawQueryParameters

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

Configure an SdkHttpRequest.rawQueryParameters() to be used in the created HTTP request. This is not validated until the http request is created. This overrides any values currently configured in the builder. The query parameters MUST NOT be URL encoded.

Justification of requirements: The query parameters must not be encoded when they are configured because some HTTP implementations perform this encoding automatically.

Specified by:

rawQueryParameters in interface SdkHttpRequest.Builder

removeQueryParameter

SdkHttpFullRequest.Builder removeQueryParameter(String paramName)

Remove all values for the requested query parameter from this builder.

Specified by:

removeQueryParameter in interface SdkHttpRequest.Builder

clearQueryParameters

SdkHttpFullRequest.Builder clearQueryParameters()

Removes all query parameters from this builder.

Specified by:

clearQueryParameters in interface SdkHttpRequest.Builder

method

SdkHttpMethod method()

The path, exactly as it was configured with method(SdkHttpMethod).

Specified by:

method in interface SdkHttpRequest.Builder

method

SdkHttpFullRequest.Builder method(SdkHttpMethod httpMethod)

Configure an SdkHttpRequest.method() to be used in the created HTTP request. This is not validated until the http request is created.

Specified by:

method in interface SdkHttpRequest.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 SdkHttpHeaders

Specified by:

headers in interface SdkHttpRequest.Builder

Returns:

An unmodifiable map of all headers in this message.

putHeader

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

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

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

Specified by:

putHeader in interface SdkHttpRequest.Builder

Parameters:

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

headerValue - The value for the header

putHeader

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

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

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

Specified by:

putHeader in interface SdkHttpRequest.Builder

Parameters:

headerName - The name of the header to add

headerValues - The values for the header

appendHeader

SdkHttpFullRequest.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 SdkHttpRequest.Builder

Parameters:

headerName - The name of the header to add

headerValue - The value for the header

headers

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

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

Specified by:

headers in interface SdkHttpRequest.Builder

removeHeader

SdkHttpFullRequest.Builder removeHeader(String headerName)

Remove all values for the requested header from this builder.

Specified by:

removeHeader in interface SdkHttpRequest.Builder

clearHeaders

SdkHttpFullRequest.Builder clearHeaders()

Removes all headers from this builder.

Specified by:

clearHeaders in interface SdkHttpRequest.Builder

contentStreamProvider

SdkHttpFullRequest.Builder contentStreamProvider(ContentStreamProvider contentStreamProvider)

Set the ContentStreamProvider for this request.

Parameters:

contentStreamProvider - The ContentStreamProvider.

Returns:

This object for method chaining.

contentStreamProvider

ContentStreamProvider contentStreamProvider()

Returns:

The ContentStreamProvider for this request.

copy

SdkHttpFullRequest.Builder copy()

Description copied from interface: CopyableBuilder

A shallow copy of this object created by building an immutable T and then transforming it back to a builder.

Specified by:

copy in interface CopyableBuilder<SdkHttpRequest.Builder,SdkHttpRequest>

Returns:

a copy of this object

applyMutation

SdkHttpFullRequest.Builder applyMutation(Consumer<SdkHttpRequest.Builder> mutator)

Description copied from interface: SdkBuilder

A convenience operator that takes something that will mutate the builder in some way and allows inclusion of it in chaining operations. For example instead of:

 Builder builder = ClassBeingBuilt.builder();
 builder = Util.addSomeDetailToTheBuilder(builder);
 ClassBeingBuilt clz = builder.build();
 

This can be done in a statement:

 ClassBeingBuilt = ClassBeingBuilt.builder().applyMutation(Util::addSomeDetailToTheBuilder).build();
 

Specified by:

applyMutation in interface SdkBuilder<SdkHttpRequest.Builder,SdkHttpRequest>

Parameters:

mutator - the function that mutates the builder

Returns:

B the mutated builder instance

build

SdkHttpFullRequest build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<SdkHttpRequest.Builder,SdkHttpRequest>

Returns:

an instance of T