HttpRequest

All Superinterfaces:

HttpMetaData, HttpRequestMetaData
```
public interface HttpRequest
extends HttpRequestMetaData
```
An HTTP request. The payload is represented as a single Object.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default HttpRequest`	`addCookie(java.lang.CharSequence name, java.lang.CharSequence value)` Adds a cookie with the specified `name` and `value`.
`default HttpRequest`	`addCookie(HttpCookiePair cookie)` Adds a cookie.
`default HttpRequest`	`addHeader(java.lang.CharSequence name, java.lang.CharSequence value)` Adds a new header with the specified `name` and `value`.
`default HttpRequest`	`addHeaders(HttpHeaders headers)` Adds all header names and values of `headers` object.
`HttpRequest`	`addQueryParameter(java.lang.String key, java.lang.String value)` Adds a new query parameter with the specified `key` and `value`, which will be percent-encoded if needed.
`HttpRequest`	`addQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)` Adds new query parameters with the specified `key` and `values`.
`HttpRequest`	`addQueryParameters(java.lang.String key, java.lang.String... values)` Adds new query parameters with the specified `key` and `values`.
`default HttpRequest`	`addSetCookie(java.lang.CharSequence name, java.lang.CharSequence value)` Adds a set-cookie with the specified `name` and `value`.
`default HttpRequest`	`addSetCookie(HttpSetCookie cookie)` Adds a set-cookie.
`default HttpRequest`	`addTrailer(java.lang.CharSequence name, java.lang.CharSequence value)` Adds a new trailer with the specified `name` and `value`.
`default HttpRequest`	`addTrailers(HttpHeaders trailers)` Adds all trailer names and values of `trailer` object.
`HttpRequest`	`appendPathSegments(java.lang.String... segments)` Appends segments to the current `HttpRequestMetaData.path()`, performing encoding of each segment (including (`'/'`) characters) according to percent-encoding.
`HttpRequest`	`method(HttpRequestMethod method)` Set the `HttpRequestMethod` of this `StreamingHttpRequest`.
`HttpRequest`	`path(java.lang.String path)` Sets the path, performing encoding according to percent-encoding, except for forward-slash (`'/'`) characters.
`Buffer`	`payloadBody()` Gets the underlying payload as a `Buffer`.
`HttpRequest`	`payloadBody(Buffer payloadBody)` Returns an `HttpRequest` with its underlying payload set to `payloadBody`.
`default <T> T`	`payloadBody(HttpDeserializer<T> deserializer)` Gets and deserializes the payload body.
`<T> HttpRequest`	`payloadBody(T pojo, HttpSerializer<T> serializer)` Returns an `HttpRequest` with its underlying payload set to the results of serialization of `pojo`.
`HttpRequest`	`rawPath(java.lang.String path)` Sets the path to `path`, without any encoding performed.
`HttpRequest`	`rawQuery(java.lang.String query)` Sets the query component to `query`, without any encoding performed.
`HttpRequest`	`requestTarget(java.lang.String requestTarget)` Set the request-target.
`default HttpRequest`	`setHeader(java.lang.CharSequence name, java.lang.CharSequence value)` Sets a header with the specified `name` and `value`.
`default HttpRequest`	`setHeaders(HttpHeaders headers)` Clears the current header entries and copies all header entries of the specified `headers` object.
`HttpRequest`	`setQueryParameter(java.lang.String key, java.lang.String value)` Sets a query parameter with the specified `key` and `value`, which will be percent-encoded if needed.
`HttpRequest`	`setQueryParameters(java.lang.String key, java.lang.Iterable<java.lang.String> values)` Sets new query parameters with the specified `key` and `values`.
`HttpRequest`	`setQueryParameters(java.lang.String key, java.lang.String... values)` Sets new query parameters with the specified `key` and `values`.
`default HttpRequest`	`setTrailer(java.lang.CharSequence name, java.lang.CharSequence value)` Sets a trailer with the specified `name` and `value`.
`default HttpRequest`	`setTrailers(HttpHeaders trailers)` Clears the current trailer entries and copies all trailer entries of the specified `trailers` object.
`BlockingStreamingHttpRequest`	`toBlockingStreamingRequest()` Translates this `HttpRequest` to a `BlockingStreamingHttpRequest`.
`StreamingHttpRequest`	`toStreamingRequest()` Translates this `HttpRequest` to a `StreamingHttpRequest`.
`HttpHeaders`	`trailers()` Gets the trailers.
`HttpRequest`	`version(HttpProtocolVersion version)` Set the protocol version of this `HttpMetaData`.

Methods inherited from interface io.servicetalk.http.api.HttpRequestMetaData
effectiveHost, effectivePort, hasQueryParameter, hasQueryParameter, host, method, path, port, queryParameter, queryParameters, queryParameters, queryParametersIterator, queryParametersKeys, queryParametersSize, rawPath, rawQuery, removeQueryParameters, removeQueryParameters, requestTarget, scheme, userInfo

Methods inherited from interface io.servicetalk.http.api.HttpMetaData
headers, toString, toString, version

- Method Detail
  - payloadBody
```
Buffer payloadBody()
```
    Gets the underlying payload as a Buffer.
    
    Returns:
    
    The Buffer representation of the underlying payload.
  - payloadBody
```
default <T> T payloadBody(HttpDeserializer<T> deserializer)
```
    Gets and deserializes the payload body.
    
    Type Parameters:
    
    T - The resulting type of the deserialization operation.
    
    Parameters:
    
    deserializer - The function that deserializes the underlying Object.
    
    Returns:
    
    The results of the deserialization operation.
  - payloadBody
```
HttpRequest payloadBody(Buffer payloadBody)
```
    Returns an HttpRequest with its underlying payload set to payloadBody.
    
    Parameters:
    
    payloadBody - the underlying payload.
    
    Returns:
    
    this
  - payloadBody
```
<T> HttpRequest payloadBody(T pojo,
                            HttpSerializer<T> serializer)
```
    Returns an HttpRequest with its underlying payload set to the results of serialization of pojo.
    
    Type Parameters:
    
    T - The type of object to serialize.
    
    Parameters:
    
    pojo - The object to serialize.
    
    serializer - The HttpSerializer which converts pojo into bytes.
    
    Returns:
    
    this
  - toStreamingRequest
```
StreamingHttpRequest toStreamingRequest()
```
    Translates this HttpRequest to a StreamingHttpRequest.
    
    Returns:
    
    a StreamingHttpRequest representation of this HttpRequest.
  - toBlockingStreamingRequest
```
BlockingStreamingHttpRequest toBlockingStreamingRequest()
```
    Translates this HttpRequest to a BlockingStreamingHttpRequest.
    
    Returns:
    
    a BlockingStreamingHttpRequest representation of this HttpRequest.
  - rawPath
```
HttpRequest rawPath(java.lang.String path)
```
    Description copied from interface: HttpRequestMetaData
    
    Sets the path to path, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.
    Because this modifies the request target, this may result in the clearing of internal caches. See HttpRequestMetaData.requestTarget(String).
    
    Specified by:
    
    rawPath in interface HttpRequestMetaData
    
    Parameters:
    
    path - the encoded path to set.
    
    Returns:
    
    this.
  - path
```
HttpRequest path(java.lang.String path)
```
    Description copied from interface: HttpRequestMetaData
    
    Sets the path, performing encoding according to percent-encoding, except for forward-slash ('/') characters. This allows for path("/abc") without it turning into '%2Fabc'.
    
    Specified by:
    
    path in interface HttpRequestMetaData
    
    Parameters:
    
    path - the un-encoded path to set.
    
    Returns:
    
    this.
  - appendPathSegments
```
HttpRequest appendPathSegments(java.lang.String... segments)
```
    Description copied from interface: HttpRequestMetaData
    
    Appends segments to the current HttpRequestMetaData.path(), performing encoding of each segment (including ('/') characters) according to percent-encoding. A / is used to separate each segment and between the current HttpRequestMetaData.path() and the following segments.
    
    Specified by:
    
    appendPathSegments in interface HttpRequestMetaData
    
    Parameters:
    
    segments - the un-encoded path to set.
    
    Returns:
    
    this.
  - rawQuery
```
HttpRequest rawQuery(java.lang.String query)
```
    Description copied from interface: HttpRequestMetaData
    
    Sets the query component to query, without any encoding performed. This assumes that any characters that require encoding have been encoded according to percent-encoding by the caller.
    Because this modifies the request target, this may result in the clearing of internal caches. See HttpRequestMetaData.requestTarget(String).
    
    Specified by:
    
    rawQuery in interface HttpRequestMetaData
    
    Parameters:
    
    query - the encoded query to set.
    
    Returns:
    
    this.
  - addQueryParameter
```
HttpRequest addQueryParameter(java.lang.String key,
                              java.lang.String value)
```
    Description copied from interface: HttpRequestMetaData
    
    Adds a new query parameter with the specified key and value, which will be percent-encoded if needed.
    
    Specified by:
    
    addQueryParameter in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value.
    
    Returns:
    
    this.
  - addQueryParameters
```
HttpRequest addQueryParameters(java.lang.String key,
                               java.lang.Iterable<java.lang.String> values)
```
    Description copied from interface: HttpRequestMetaData
    Adds new query parameters with the specified key and values. This method is semantically equivalent to:
```
 for (T value : values) {
     addQueryParameter(key, value);
 }
 
```
    Specified by:
    
    addQueryParameters in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - addQueryParameters
```
HttpRequest addQueryParameters(java.lang.String key,
                               java.lang.String... values)
```
    Description copied from interface: HttpRequestMetaData
    Adds new query parameters with the specified key and values. This method is semantically equivalent to:
```
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Specified by:
    
    addQueryParameters in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - setQueryParameter
```
HttpRequest setQueryParameter(java.lang.String key,
                              java.lang.String value)
```
    Description copied from interface: HttpRequestMetaData
    
    Sets a query parameter with the specified key and value, which will be percent-encoded if needed. Any existing query parameters with the same key are overwritten.
    
    Specified by:
    
    setQueryParameter in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    value - the query parameter value.
    
    Returns:
    
    this.
  - setQueryParameters
```
HttpRequest setQueryParameters(java.lang.String key,
                               java.lang.Iterable<java.lang.String> values)
```
    Description copied from interface: HttpRequestMetaData
    Sets new query parameters with the specified key and values. This method is equivalent to:
```
 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Specified by:
    
    setQueryParameters in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - setQueryParameters
```
HttpRequest setQueryParameters(java.lang.String key,
                               java.lang.String... values)
```
    Description copied from interface: HttpRequestMetaData
    Sets new query parameters with the specified key and values. This method is equivalent to:
```
 removeQueryParameter(key);
 for (T value : values) {
     query.addQueryParameter(key, value);
 }
 
```
    Specified by:
    
    setQueryParameters in interface HttpRequestMetaData
    
    Parameters:
    
    key - the query parameter key.
    
    values - the query parameter values.
    
    Returns:
    
    this.
  - version
```
HttpRequest version(HttpProtocolVersion version)
```
    Description copied from interface: HttpMetaData
    
    Set the protocol version of this HttpMetaData.
    
    Specified by:
    
    version in interface HttpMetaData
    
    Specified by:
    
    version in interface HttpRequestMetaData
    
    Parameters:
    
    version - the protocol version to set.
    
    Returns:
    
    this.
  - method
```
HttpRequest method(HttpRequestMethod method)
```
    Description copied from interface: HttpRequestMetaData
    
    Set the HttpRequestMethod of this StreamingHttpRequest.
    
    Specified by:
    
    method in interface HttpRequestMetaData
    
    Parameters:
    
    method - the HttpRequestMethod to set.
    
    Returns:
    
    this.
  - requestTarget
```
HttpRequest requestTarget(java.lang.String requestTarget)
```
    Description copied from interface: HttpRequestMetaData
    
    Set the request-target.
    This will be treated as encoded according to percent-encoding.
    This may result in clearing of internal caches used by methods that are derived from the request-target, such as HttpRequestMetaData.path(), HttpRequestMetaData.rawQuery(), etc.
    
    Specified by:
    
    requestTarget in interface HttpRequestMetaData
    
    Parameters:
    
    requestTarget - the percent-encoded request-target to set.
    
    Returns:
    
    this.
  - addHeader
```
default HttpRequest addHeader(java.lang.CharSequence name,
                              java.lang.CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a new header with the specified name and value.
    
    Specified by:
    
    addHeader in interface HttpMetaData
    
    Specified by:
    
    addHeader in interface HttpRequestMetaData
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header.
    
    Returns:
    
    this.
  - addHeaders
```
default HttpRequest addHeaders(HttpHeaders headers)
```
    Description copied from interface: HttpMetaData
    
    Adds all header names and values of headers object.
    
    Specified by:
    
    addHeaders in interface HttpMetaData
    
    Specified by:
    
    addHeaders in interface HttpRequestMetaData
    
    Parameters:
    
    headers - the headers to add.
    
    Returns:
    
    this.
  - setHeader
```
default HttpRequest setHeader(java.lang.CharSequence name,
                              java.lang.CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Sets a header with the specified name and value. Any existing headers with the same name are overwritten.
    
    Specified by:
    
    setHeader in interface HttpMetaData
    
    Specified by:
    
    setHeader in interface HttpRequestMetaData
    
    Parameters:
    
    name - the name of the header.
    
    value - the value of the header.
    
    Returns:
    
    this.
  - setHeaders
```
default HttpRequest setHeaders(HttpHeaders headers)
```
    Description copied from interface: HttpMetaData
    
    Clears the current header entries and copies all header entries of the specified headers object.
    
    Specified by:
    
    setHeaders in interface HttpMetaData
    
    Specified by:
    
    setHeaders in interface HttpRequestMetaData
    
    Parameters:
    
    headers - the headers object which contains new values.
    
    Returns:
    
    this.
  - addCookie
```
default HttpRequest addCookie(HttpCookiePair cookie)
```
    Description copied from interface: HttpMetaData
    
    Adds a cookie.
    This may result in multiple HttpCookiePairs with same name.
    
    Specified by:
    
    addCookie in interface HttpMetaData
    
    Specified by:
    
    addCookie in interface HttpRequestMetaData
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    this.
  - addCookie
```
default HttpRequest addCookie(java.lang.CharSequence name,
                              java.lang.CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a cookie with the specified name and value.
    This may result in multiple HttpSetCookies with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.
    
    Specified by:
    
    addCookie in interface HttpMetaData
    
    Specified by:
    
    addCookie in interface HttpRequestMetaData
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Returns:
    
    this.
  - addSetCookie
```
default HttpRequest addSetCookie(HttpSetCookie cookie)
```
    Description copied from interface: HttpMetaData
    
    Adds a set-cookie.
    This may result in multiple HttpSetCookies with same name.
    
    Specified by:
    
    addSetCookie in interface HttpMetaData
    
    Specified by:
    
    addSetCookie in interface HttpRequestMetaData
    
    Parameters:
    
    cookie - the cookie to add.
    
    Returns:
    
    this.
  - addSetCookie
```
default HttpRequest addSetCookie(java.lang.CharSequence name,
                                 java.lang.CharSequence value)
```
    Description copied from interface: HttpMetaData
    
    Adds a set-cookie with the specified name and value.
    This may result in multiple HttpSetCookies with same name. Added cookie will not be wrapped, not secure, and not HTTP-only, with no path, domain, expire date and maximum age.
    
    Specified by:
    
    addSetCookie in interface HttpMetaData
    
    Specified by:
    
    addSetCookie in interface HttpRequestMetaData
    
    Parameters:
    
    name - the name of the cookie.
    
    value - the value of the cookie.
    
    Returns:
    
    this.
  - addTrailer
```
default HttpRequest addTrailer(java.lang.CharSequence name,
                               java.lang.CharSequence value)
```
    Adds a new trailer with the specified name and value.
    
    Parameters:
    
    name - the name of the trailer.
    
    value - the value of the trailer.
    
    Returns:
    
    this.
  - addTrailers
```
default HttpRequest addTrailers(HttpHeaders trailers)
```
    Adds all trailer names and values of trailer object.
    
    Parameters:
    
    trailers - the trailers to add.
    
    Returns:
    
    this.
  - setTrailer
```
default HttpRequest setTrailer(java.lang.CharSequence name,
                               java.lang.CharSequence value)
```
    Sets a trailer with the specified name and value. Any existing trailers with the same name are overwritten.
    
    Parameters:
    
    name - the name of the trailer.
    
    value - the value of the trailer.
    
    Returns:
    
    this.
  - setTrailers
```
default HttpRequest setTrailers(HttpHeaders trailers)
```
    Clears the current trailer entries and copies all trailer entries of the specified trailers object.
    
    Parameters:
    
    trailers - the trailers object which contains new values.
    
    Returns:
    
    this.
  - trailers
```
HttpHeaders trailers()
```
    Gets the trailers.
    
    Returns:
    
    the trailers.

Interface HttpRequest

Method Summary

Methods inherited from interface io.servicetalk.http.api.HttpRequestMetaData

Methods inherited from interface io.servicetalk.http.api.HttpMetaData

Method Detail

payloadBody

payloadBody

payloadBody

payloadBody

toStreamingRequest

toBlockingStreamingRequest

rawPath

path

appendPathSegments

rawQuery

addQueryParameter

addQueryParameters

addQueryParameters

setQueryParameter

setQueryParameters

setQueryParameters

version

method

requestTarget

addHeader

addHeaders

setHeader

setHeaders

addCookie

addCookie

addSetCookie

addSetCookie

addTrailer

addTrailers

setTrailer

setTrailers

trailers