RequestBuilder (Okta Java SDK 8.2.5 API)

```
public interface RequestBuilder
```
A RequestBuilder allows for making Resource based request to any Okta endpoint. Not all Okta endpoints are implemented by this SDK currently, this interface allow to make requests with:
- Any Resource as the request body
- Setting query parameters
- GET, POST, PUT, and DELETE requests
Example usage for the Set Password:
// create a resource Resource userPasswordRequest = client.instantiate(ExtensibleResource) userPasswordRequest.put("credentials", client.instantiate(ExtensibleResource) .put("password", client.instantiate(ExtensibleResource) .put("value", "aPassword1!".toCharArray()))) // make a POST request to `/api/v1/users/{userId}` and return a User resource User result = client.getDataStore().http() .setBody(userPasswordRequest) .post("/api/v1/users/"+ userId, User.class)
Since:

1.2.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`RequestBuilder`	`addHeaderParameter(String key, List<String> values)` Adds a header parameter to the request builder.
`RequestBuilder`	`addHeaderParameter(String key, String value)` Adds a header parameter to the request builder.
`RequestBuilder`	`addQueryParameter(String key, String value)` Adds a query parameter to the request builder.
`void`	`delete(String href)` Executes a `DELETE` request.
`<T extends Resource> T`	`get(String href, Class<T> type)` Executes a `GET` request and returns a Resource.
`InputStream`	`getRaw(String href)` Executes a `GET` request and returns a raw response.
`default void`	`post(String href)` Executes a `POST` request.
`<T extends Resource> T`	`post(String href, Class<T> type)` Executes a `POST` request and returns a Resource.
`void`	`put(String href)` Executes a `PUT` request and updates the resource used as the `body`.
`RequestBuilder`	`setBody(Resource resource)` Sets the Resource body for the request.
`RequestBuilder`	`setHeaderParameters(Map<String,List<String>> headerParams)` Sets the header parameters to be used for the request.
`RequestBuilder`	`setQueryParameters(Map<String,String> queryParams)` Sets the query parameters to be used for the request.

- Method Detail
  - setBody
```
RequestBuilder setBody(Resource resource)
```
    Sets the Resource body for the request.
    
    Parameters:
    
    resource - the request body
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - addQueryParameter
```
RequestBuilder addQueryParameter(String key,
                                 String value)
```
    Adds a query parameter to the request builder.
    
    Parameters:
    
    key - the query parameter field name
    
    value - the query parameter field value
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - setQueryParameters
```
RequestBuilder setQueryParameters(Map<String,String> queryParams)
```
    Sets the query parameters to be used for the request.
    
    Parameters:
    
    queryParams - the query parameters to be used for the request
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - addHeaderParameter
```
RequestBuilder addHeaderParameter(String key,
                                  String value)
```
    Adds a header parameter to the request builder.
    
    Parameters:
    
    key - the header parameter field name
    
    value - the header parameter field value
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - addHeaderParameter
```
RequestBuilder addHeaderParameter(String key,
                                  List<String> values)
```
    Adds a header parameter to the request builder.
    
    Parameters:
    
    key - the header parameter field name
    
    values - the header parameter field values
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - setHeaderParameters
```
RequestBuilder setHeaderParameters(Map<String,List<String>> headerParams)
```
    Sets the header parameters to be used for the request.
    
    Parameters:
    
    headerParams - the header parameters to be used for the request
    
    Returns:
    
    the RequestBuilder to allow for chaining methods.
  - get
```
<T extends Resource> T get(String href,
                           Class<T> type)
```
    Executes a GET request and returns a Resource.
    
    Type Parameters:
    
    T - the Resource type to return
    
    Parameters:
    
    href - an absolute or partial HREF
    
    type - the Resource type to return
    
    Returns:
    
    The response payload unmarshalled into a Resource
  - getRaw
```
InputStream getRaw(String href)
```
    Executes a GET request and returns a raw response.
    
    Parameters:
    
    href - an absolute or partial HREF
    
    Returns:
    
    The response payload as InputStream
  - put
```
void put(String href)
```
    Executes a PUT request and updates the resource used as the body.
    
    Parameters:
    
    href - an absolute or partial HREF
  - post
```
<T extends Resource> T post(String href,
                            Class<T> type)
```
    Executes a POST request and returns a Resource.
    
    Type Parameters:
    
    T - the Resource type to return
    
    Parameters:
    
    href - an absolute or partial HREF
    
    type - the Resource type to return
    
    Returns:
    
    The response payload unmarshalled into a Resource
  - post
```
default void post(String href)
```
    Executes a POST request.
    
    Parameters:
    
    href - an absolute or partial HREF
  - delete
```
void delete(String href)
```
    Executes a DELETE request.
    
    Parameters:
    
    href - an absolute or partial HREF

Interface RequestBuilder

Method Summary

Method Detail

setBody

addQueryParameter

setQueryParameters

addHeaderParameter

addHeaderParameter

setHeaderParameters

get

getRaw

put

post

post

delete