All Implemented Interfaces:

com.tryfinch.api.core.Params
```
public final class RequestForwardingForwardParams
 implements Params
                    
```
The Forward API allows you to make direct requests to an employment system. If Finch's unified API doesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull data models directly against an integration's API.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`RequestForwardingForwardParams.Builder`	A builder for RequestForwardingForwardParams.
`public final class`	`RequestForwardingForwardParams.ForwardRequest`
`public final class`	`RequestForwardingForwardParams.Params`	The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.
`public final class`	`RequestForwardingForwardParams.RequestHeaders`	The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{"Content-Type": "application/xml", "X-API-Version": "v1" }`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`method()`	The HTTP method for the forwarded request.
`final String`	`route()`	The URL route path for the forwarded request.
`final Optional<String>`	`data()`	The body for the forwarded request.
`final Optional<RequestForwardingForwardParams.Params>`	`params()`	The query parameters for the forwarded request.
`final Optional<RequestForwardingForwardParams.RequestHeaders>`	`requestHeaders()`	The HTTP headers to include on the forwarded request.
`final JsonField<String>`	`_method()`	Returns the raw JSON value of method.
`final JsonField<String>`	`_route()`	Returns the raw JSON value of route.
`final JsonField<String>`	`_data()`	Returns the raw JSON value of data.
`final JsonField<RequestForwardingForwardParams.Params>`	`_params()`	Returns the raw JSON value of params.
`final JsonField<RequestForwardingForwardParams.RequestHeaders>`	`_requestHeaders()`	Returns the raw JSON value of requestHeaders.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final RequestForwardingForwardParams.Builder`	`toBuilder()`
`final RequestForwardingForwardParams.ForwardRequest`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static RequestForwardingForwardParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of RequestForwardingForwardParams.

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

- Constructor Detail
- Method Detail
  - method
```
 final String method()
```
    The HTTP method for the forwarded request. Valid values include: GET , POST , PUT , DELETE , and PATCH.
  - route
```
 final String route()
```
    The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.
  - data
```
 final Optional<String> data()
```
    The body for the forwarded request. This value must be specified as either a string or a valid JSON object.
  - params
```
 final Optional<RequestForwardingForwardParams.Params> params()
```
    The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.
  - requestHeaders
```
 final Optional<RequestForwardingForwardParams.RequestHeaders> requestHeaders()
```
    The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: {"Content-Type": "application/xml", "X-API-Version": "v1" }
  - _method
```
 final JsonField<String> _method()
```
    Returns the raw JSON value of method.
    Unlike method, this method doesn't throw if the JSON field has an unexpected type.
  - _route
```
 final JsonField<String> _route()
```
    Returns the raw JSON value of route.
    Unlike route, this method doesn't throw if the JSON field has an unexpected type.
  - _data
```
 final JsonField<String> _data()
```
    Returns the raw JSON value of data.
    Unlike data, this method doesn't throw if the JSON field has an unexpected type.
  - _params
```
 final JsonField<RequestForwardingForwardParams.Params> _params()
```
    Returns the raw JSON value of params.
    Unlike params, this method doesn't throw if the JSON field has an unexpected type.
  - _requestHeaders
```
 final JsonField<RequestForwardingForwardParams.RequestHeaders> _requestHeaders()
```
    Returns the raw JSON value of requestHeaders.
    Unlike requestHeaders, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final RequestForwardingForwardParams.Builder toBuilder()
```
  - _body
```
 final RequestForwardingForwardParams.ForwardRequest _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static RequestForwardingForwardParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of RequestForwardingForwardParams.
    The following fields are required:
    .method() .route()

Class RequestForwardingForwardParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

method

route

data

params

requestHeaders

_method

_route

_data

_params

_requestHeaders

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder