HttpBuildersSPI.RequestBuilder (Werval API Reference (0.7.5))

Enclosing interface:

HttpBuildersSPI
```
public static interface HttpBuildersSPI.RequestBuilder
```
Request Builder.
HTTP Method and URI are mandatory.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HttpBuildersSPI.RequestBuilder`	`bodyBytes(ByteSource bodyBytes)` Body bytes.
`HttpBuildersSPI.RequestBuilder`	`bodyForm(Map<String,List<String>> attributes, Map<String,List<FormUploads.Upload>> uploads)` Body form and uploads.
`Request`	`build()` Build a new Request.
`HttpBuildersSPI.RequestBuilder`	`connect(String uri)` HTTP CONNECT method on URI.
`HttpBuildersSPI.RequestBuilder`	`cookies(Cookies cookies)` Request cookies.
`HttpBuildersSPI.RequestBuilder`	`delete(String uri)` HTTP DELETE method on URI.
`HttpBuildersSPI.RequestBuilder`	`get(String uri)` HTTP GET method on URI.
`HttpBuildersSPI.RequestBuilder`	`head(String uri)` HTTP HEAD method on URI.
`HttpBuildersSPI.RequestBuilder`	`headers(Headers headers)` Request headers.
`HttpBuildersSPI.RequestBuilder`	`headers(Map<String,List<String>> headers)` Request headers.
`HttpBuildersSPI.RequestBuilder`	`identifiedBy(String identity)` Request identity.
`HttpBuildersSPI.RequestBuilder`	`method(Method method)` HTTP method.
`HttpBuildersSPI.RequestBuilder`	`method(String method)` HTTP method.
`HttpBuildersSPI.RequestBuilder`	`options(String uri)` HTTP OPTIONS method on URI.
`HttpBuildersSPI.RequestBuilder`	`patch(String uri)` HTTP PATCH method on URI.
`HttpBuildersSPI.RequestBuilder`	`post(String uri)` HTTP POST method on URI.
`HttpBuildersSPI.RequestBuilder`	`put(String uri)` HTTP PUT method on URI.
`HttpBuildersSPI.RequestBuilder`	`remoteSocketAddress(String remoteSocketAddress)` Remote socket address.
`HttpBuildersSPI.RequestBuilder`	`trace(String uri)` HTTP TRACE method on URI.
`HttpBuildersSPI.RequestBuilder`	`uri(String uri)` URI.
`HttpBuildersSPI.RequestBuilder`	`version(ProtocolVersion version)` Protocol version.

- Method Detail
  - identifiedBy
```
HttpBuildersSPI.RequestBuilder identifiedBy(String identity)
```
    Request identity.
    Default to NO_REQUEST_ID.
    
    Parameters:
    
    identity - Request identity
    
    Returns:
    
    A new builder with the request identity set
  - remoteSocketAddress
```
HttpBuildersSPI.RequestBuilder remoteSocketAddress(String remoteSocketAddress)
```
    Remote socket address.
    Optional.
    
    Parameters:
    
    remoteSocketAddress - Remote socket address
    
    Returns:
    
    A new builder with the remote socket address set
  - version
```
HttpBuildersSPI.RequestBuilder version(ProtocolVersion version)
```
    Protocol version.
    Default to ProtocolVersion.HTTP_1_1.
    
    Parameters:
    
    version - Protocol version
    
    Returns:
    
    A new builder with the protocol version set
  - method
```
HttpBuildersSPI.RequestBuilder method(String method)
```
    HTTP method.
    Mandatory.
    
    Parameters:
    
    method - HTTP method
    
    Returns:
    
    A new builder with the method set
  - method
```
HttpBuildersSPI.RequestBuilder method(Method method)
```
    HTTP method.
    Mandatory.
    
    Parameters:
    
    method - HTTP method
    
    Returns:
    
    A new builder with the method set
  - uri
```
HttpBuildersSPI.RequestBuilder uri(String uri)
```
    URI.
    Mandatory.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the URI set
  - get
```
HttpBuildersSPI.RequestBuilder get(String uri)
```
    HTTP GET method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - head
```
HttpBuildersSPI.RequestBuilder head(String uri)
```
    HTTP HEAD method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - options
```
HttpBuildersSPI.RequestBuilder options(String uri)
```
    HTTP OPTIONS method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - trace
```
HttpBuildersSPI.RequestBuilder trace(String uri)
```
    HTTP TRACE method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - connect
```
HttpBuildersSPI.RequestBuilder connect(String uri)
```
    HTTP CONNECT method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - put
```
HttpBuildersSPI.RequestBuilder put(String uri)
```
    HTTP PUT method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - post
```
HttpBuildersSPI.RequestBuilder post(String uri)
```
    HTTP POST method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - patch
```
HttpBuildersSPI.RequestBuilder patch(String uri)
```
    HTTP PATCH method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - delete
```
HttpBuildersSPI.RequestBuilder delete(String uri)
```
    HTTP DELETE method on URI.
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    A new builder with the HTTP method and URI set
  - headers
```
HttpBuildersSPI.RequestBuilder headers(Headers headers)
```
    Request headers.
    
    Parameters:
    
    headers - Request headers
    
    Returns:
    
    A new builder with the headers set
  - headers
```
HttpBuildersSPI.RequestBuilder headers(Map<String,List<String>> headers)
```
    Request headers.
    
    Parameters:
    
    headers - Request headers
    
    Returns:
    
    A new builder with the headers set
  - cookies
```
HttpBuildersSPI.RequestBuilder cookies(Cookies cookies)
```
    Request cookies.
    
    Parameters:
    
    cookies - Request cookies
    
    Returns:
    
    A new builder with the cookies set
  - bodyBytes
```
HttpBuildersSPI.RequestBuilder bodyBytes(ByteSource bodyBytes)
```
    Body bytes.
    
    Parameters:
    
    bodyBytes - Body bytes
    
    Returns:
    
    A new builder with the body set
  - bodyForm
```
HttpBuildersSPI.RequestBuilder bodyForm(Map<String,List<String>> attributes,
                                        Map<String,List<FormUploads.Upload>> uploads)
```
    Body form and uploads.
    
    Parameters:
    
    attributes - Form attributes
    
    uploads - Multipart uploads
    
    Returns:
    
    A new builder with the body set
  - build
```
Request build()
```
    Build a new Request.
    
    Returns:
    
    A new Request
    
    Throws:
    
    IllegalArgumentException - if the builder state is not appropriate

Interface HttpBuildersSPI.RequestBuilder

Method Summary

Method Detail

identifiedBy

remoteSocketAddress

version

method

method

uri

get

head

options

trace

connect

put

post

patch

delete

headers

headers

cookies

bodyBytes

bodyForm

build