org.everit.http.restclient

Class RestRequest.Builder

java.lang.Object

org.everit.http.restclient.RestRequest.Builder

Enclosing class:

RestRequest

@Generated(value="SparkTools")
public static final class RestRequest.Builder
extends Object

Builder to build RestRequest.

Method Summary

Modifier and Type	Method and Description
RestRequest.Builder	basePath(String basePath) The base path of the request with probably the protocol, hostname and optionally the port.
RestRequest	build() Builds the unmodifiable rest request instance.
RestRequest.Builder	headers(Map<String,String> headers) The headers of the rest request.
RestRequest.Builder	method(org.everit.http.client.HttpMethod method) Method of the rest request.
RestRequest.Builder	path(String path) Path of the rest request.
RestRequest.Builder	pathParams(Map<String,String> pathParams) Path parameters that will be injected within path(String).
RestRequest.Builder	queryParams(Map<String,Collection<String>> queryParams) Query parameters that will be appended after the path.
RestRequest.Builder	requestBody(Optional<?> requestBody) Optional body of the request.

Methods inherited from class java.lang.Object

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

Method Detail

basePath

public RestRequest.Builder basePath(String basePath)

The base path of the request with probably the protocol, hostname and optionally the port.

build

public RestRequest build()

Builds the unmodifiable rest request instance.

headers

public RestRequest.Builder headers(Map<String,String> headers)

The headers of the rest request.

method

public RestRequest.Builder method(org.everit.http.client.HttpMethod method)

Method of the rest request. Default: HttpMethod.GET

path

public RestRequest.Builder path(String path)

Path of the rest request.

pathParams

public RestRequest.Builder pathParams(Map<String,String> pathParams)

Path parameters that will be injected within path(String).

queryParams

public RestRequest.Builder queryParams(Map<String,Collection<String>> queryParams)

Query parameters that will be appended after the path.

requestBody

public RestRequest.Builder requestBody(Optional<?> requestBody)

Optional body of the request. If the object is an implementation of AsyncContentProvider it is be used as is, otherwise Jackson is used to convert the object to a JSON String.