RequestBuilder (Autocomplete Parameter Plugin 1.0 API)

java.lang.Object
- wirelabs.commons.RequestBuilder

```
public class RequestBuilder
extends Object
```
A class to create requests with a fluent and simple interface. Usage: RequestBuilder.url("a url") .. add headers and other options .get|post|put|delete|patch

Author:

takeuchi

Constructor Summary

Constructors
Constructor and Description

RequestBuilder()

RequestBuilder(String url)

Constructors
Constructor and Description
`RequestBuilder()`
`RequestBuilder(String url)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptableRange(int from, int to)` Specify the acceptable range of response codes.
`RequestBuilder`	`body(Object body)` Adds the request body.
`RequestBuilder`	`cache()` Enables a request cache.
`RequestBuilder`	`cache(long ttlInMs)` Enables a request cache.
`RequestBuilder`	`credentials(String credentialsId)` Add basic authorization based from a jenkins credentials given its id
`RequestResponse`	`delete()` Perform a delete request.
`RequestResponse`	`get()` Perform a get request.
`RequestBuilder`	`header(String key, String value)` Add a header entry
`RequestResponse`	`patch()` Perform a patch request
`RequestResponse`	`post()` Perform a post request.
`RequestResponse`	`put()` Perform a put request
`static RequestBuilder`	`url(String url)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RequestBuilder
```
public RequestBuilder()
```
  - RequestBuilder
```
public RequestBuilder(String url)
```
- Method Detail
  - url
```
public static RequestBuilder url(String url)
```
  - cache
```
public RequestBuilder cache()
```
    Enables a request cache. That means other requests with enabled cache will first try to retrieve the value locally. The default cache time to live is 3 seconds.
    
    Returns:
    
    the builder
  - cache
```
public RequestBuilder cache(long ttlInMs)
```
    Enables a request cache. That means other requests with enabled cache will first try to retrieve the value locally. The default cache time to live is 3 seconds.
    
    Parameters:
    
    ttlInMs - the cache time to live in milliseconds
    
    Returns:
    
    the builder
  - header
```
public RequestBuilder header(String key,
                             String value)
```
    Add a header entry
    
    Parameters:
    
    key - header key
    
    value - header value
    
    Returns:
    
    the builder
  - credentials
```
public RequestBuilder credentials(String credentialsId)
```
    Add basic authorization based from a jenkins credentials given its id
    
    Parameters:
    
    credentialsId - the id of the credential to add
    
    Returns:
    
    the builder
  - body
```
public RequestBuilder body(Object body)
```
    Adds the request body.
    
    Parameters:
    
    body - the body contents
    
    Returns:
    
    the builder
  - acceptableRange
```
public void acceptableRange(int from,
                            int to)
```
    Specify the acceptable range of response codes. If the response code is out of this range, the request will throw an exception. The default acceptable range is 200-399
    
    Parameters:
    
    from -
    
    to -
  - post
```
public RequestResponse post()
```
    Perform a post request.
    
    Returns:
    
    the response
  - put
```
public RequestResponse put()
```
    Perform a put request
    
    Returns:
    
    the response
  - patch
```
public RequestResponse patch()
```
    Perform a patch request
    
    Returns:
    
    the response
  - get
```
public RequestResponse get()
```
    Perform a get request.
    
    Returns:
    
    the response
  - delete
```
public RequestResponse delete()
```
    Perform a delete request.
    
    Returns:
    
    the response

Class RequestBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestBuilder

RequestBuilder

Method Detail

url

cache

cache

header

credentials

body

acceptableRange

post

put

patch

get

delete