com.ibm.cloud.objectstorage

Interface SignableRequest<T>

Type Parameters:

T - The type of original, user facing request represented by this request.

All Superinterfaces:

ImmutableRequest<T>

All Known Subinterfaces:

Request<T>

All Known Implementing Classes:

DefaultRequest

public interface SignableRequest<T>
extends ImmutableRequest<T>

Represents a sign-able request being sent to an Amazon Web Service, including the parameters being sent as part of the request, the endpoint to which the request should be sent, etc.

This class is only intended for internal use inside the AWS client libraries. Callers shouldn't ever interact directly with objects of this class.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Sets the specified header for this request.
void	addParameter(String name, String value) Adds the specified request parameter to this request.
void	setContent(InputStream content) Sets the optional stream containing the payload data to include for this request.

Methods inherited from interface com.ibm.cloud.objectstorage.ImmutableRequest

getContent, getContentUnwrapped, getEndpoint, getHeaders, getHttpMethod, getOriginalRequestObject, getParameters, getReadLimitInfo, getResourcePath, getTimeOffset

Method Detail

addHeader

void addHeader(String name,
               String value)

Sets the specified header for this request.

Parameters:

name - The name of the header to set.

value - The header's value.

addParameter

void addParameter(String name,
                  String value)

Adds the specified request parameter to this request.

Parameters:

name - The name of the request parameter.

value - The value of the request parameter.

setContent

void setContent(InputStream content)

Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.

Parameters:

content - The optional stream containing the payload data to include for this request.