Package software.amazon.awssdk.http

Class DefaultSdkHttpFullRequest.Builder

java.lang.Object

software.amazon.awssdk.http.DefaultSdkHttpFullRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

DefaultSdkHttpFullRequest

public static final class DefaultSdkHttpFullRequest.Builder
extends Object
implements SdkHttpFullRequest.Builder

Builder for a DefaultSdkHttpFullRequest.

Method Summary

Modifier and Type	Method	Description
DefaultSdkHttpFullRequest	build()	An immutable object that is created from the properties that have been set on the builder.
DefaultSdkHttpFullRequest.Builder	clearQueryParameters()	Removes all query parameters from the builder.
DefaultSdkHttpFullRequest.Builder	content(InputStream content)	Sets the HTTP content for the builder.
DefaultSdkHttpFullRequest.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.
URI	getEndpoint()	Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.
Map<String,List<String>>	getHeaders()	Returns the HTTP headers returned with this object.
SdkHttpMethod	getHttpMethod()	Returns the HTTP method (GET, POST, etc) to use when sending this request.
Map<String,List<String>>	getParameters()	Returns a map of all parameters in this request.
String	getResourcePath()	Returns the path to the resource being requested.
<T> T	handlerContext(HandlerContextKey<T> key)	Gets context from the request.
<T> DefaultSdkHttpFullRequest.Builder	handlerContext(HandlerContextKey<T> key, T value)	Adds to the handler context for the builder.
DefaultSdkHttpFullRequest.Builder	header(String key, List<String> values)	Adds the header values to the builder.
DefaultSdkHttpFullRequest.Builder	headers(Map<String,List<String>> headers)	Adds the headers to the builder.
DefaultSdkHttpFullRequest.Builder	httpMethod(SdkHttpMethod httpMethod)	Sets the SdkHttpMethod for the builder.
DefaultSdkHttpFullRequest.Builder	queryParameter(String paramName, List<String> paramValues)	Adds the query parameter with multiple values to the builder.
DefaultSdkHttpFullRequest.Builder	queryParameters(Map<String,List<String>> queryParameters)	Adds the query parameters to the builder.
DefaultSdkHttpFullRequest.Builder	removeQueryParameter(String paramName)	Removes all values for the query paramter from the builder.
DefaultSdkHttpFullRequest.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 class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

apply

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

header, queryParameter

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

getFirstHeaderValue, getValuesForHeader

Method Detail

header

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

Description copied from interface: SdkHttpFullRequest.Builder

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.

Specified by:

header in interface SdkHttpFullRequest.Builder

Parameters:

key - Header name

values - List of values associated with this header key.

Returns:

This builder for method chaining.

headers

public DefaultSdkHttpFullRequest.Builder headers(Map<String,List<String>> headers)

Description copied from interface: SdkHttpFullRequest.Builder

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.

Specified by:

headers in interface SdkHttpFullRequest.Builder

Parameters:

headers - Headers to add

Returns:

This builder for method chaining.

getHeaders

public Map<String,List<String>> getHeaders()

Description copied from interface: SdkHttpHeaders

Returns the HTTP headers returned with this object.
Should never be null, if there are no headers an empty map is returned

Specified by:

getHeaders in interface SdkHttpHeaders

Returns:

The HTTP headers.

resourcePath

public DefaultSdkHttpFullRequest.Builder resourcePath(String resourcePath)

Description copied from interface: SdkHttpFullRequest.Builder

Sets the resource path on the builder.

Specified by:

resourcePath in interface SdkHttpFullRequest.Builder

Parameters:

resourcePath - New resource path.

Returns:

This builder for method chaining.

getResourcePath

public String getResourcePath()

Description copied from interface: SdkHttpRequest

Returns the path to the resource being requested.

Specified by:

getResourcePath in interface SdkHttpRequest

Returns:

The path to the resource being requested.

queryParameter

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

Description copied from interface: SdkHttpFullRequest.Builder

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.

Specified by:

queryParameter in interface SdkHttpFullRequest.Builder

Parameters:

paramName - Name of the parameter to add

paramValues - List of values associated with this query parameter.

Returns:

This builder for method chaining.

queryParameters

public DefaultSdkHttpFullRequest.Builder queryParameters(Map<String,List<String>> queryParameters)

Description copied from interface: SdkHttpFullRequest.Builder

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.

Specified by:

queryParameters in interface SdkHttpFullRequest.Builder

Parameters:

queryParameters - Query parameters to add

Returns:

This builder for method chaining.

removeQueryParameter

public DefaultSdkHttpFullRequest.Builder removeQueryParameter(String paramName)

Description copied from interface: SdkHttpFullRequest.Builder

Removes all values for the query paramter from the builder.

Specified by:

removeQueryParameter in interface SdkHttpFullRequest.Builder

Parameters:

paramName - Query param to remove.

Returns:

This builder for method chaining.

clearQueryParameters

public DefaultSdkHttpFullRequest.Builder clearQueryParameters()

Description copied from interface: SdkHttpFullRequest.Builder

Removes all query parameters from the builder.

Specified by:

clearQueryParameters in interface SdkHttpFullRequest.Builder

Returns:

This builder for method chaining.

getParameters

public Map<String,List<String>> getParameters()

Description copied from interface: SdkHttpRequest

Returns a map of all parameters in this request.
Should never be null, if there are no parameters an empty map is returned.

Specified by:

getParameters in interface SdkHttpRequest

Returns:

A map of all parameters in this request.

endpoint

public DefaultSdkHttpFullRequest.Builder endpoint(URI endpoint)

Description copied from interface: SdkHttpFullRequest.Builder

Sets the endpoint for the builder.

Specified by:

endpoint in interface SdkHttpFullRequest.Builder

Parameters:

endpoint - New endpoint.

Returns:

This builder for method chaining.

getEndpoint

public URI getEndpoint()

Description copied from interface: SdkHttpRequest

Returns the service endpoint (ex: "https://ec2.amazonaws.com") to which this request should be sent.

Specified by:

getEndpoint in interface SdkHttpRequest

Returns:

The service endpoint to which this request should be sent.

httpMethod

public DefaultSdkHttpFullRequest.Builder httpMethod(SdkHttpMethod httpMethod)

Description copied from interface: SdkHttpFullRequest.Builder

Sets the SdkHttpMethod for the builder.

Specified by:

httpMethod in interface SdkHttpFullRequest.Builder

Parameters:

httpMethod - New HTTP method.

Returns:

This builder for method chaining.

getHttpMethod

public SdkHttpMethod getHttpMethod()

Description copied from interface: SdkHttpRequest

Returns the HTTP method (GET, POST, etc) to use when sending this request.

Specified by:

getHttpMethod in interface SdkHttpRequest

Returns:

The HTTP method to use when sending this request.

content

public DefaultSdkHttpFullRequest.Builder content(InputStream content)

Description copied from interface: SdkHttpFullRequest.Builder

Sets the HTTP content for the builder.

Specified by:

content in interface SdkHttpFullRequest.Builder

Parameters:

content - New content.

Returns:

This builder for method chaining.

getContent

public InputStream getContent()

Description copied from interface: SdkHttpFullRequest.Builder

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

Specified by:

getContent in interface SdkHttpFullRequest.Builder

Returns:

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

handlerContext

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

Description copied from interface: SdkHttpFullRequest.Builder

Adds to the handler context for the builder.

Specified by:

handlerContext in interface SdkHttpFullRequest.Builder

Parameters:

key - Key to add context under.

value - Value associated with key.

Returns:

This builder for method chaining.

handlerContext

public <T> T handlerContext(HandlerContextKey<T> key)

Description copied from interface: SdkHttpRequest

Gets context from the request.

Specified by:

handlerContext in interface SdkHttpRequest

Type Parameters:

T - Type of context value.

Parameters:

key - Key of context to retrieve.

Returns:

Context value if present, null otherwise.

build

public DefaultSdkHttpFullRequest 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 SdkBuilder<SdkHttpFullRequest.Builder,SdkHttpFullRequest>

Returns:

An immutable DefaultSdkHttpFullRequest object.