AuthRuleV2BacktestRetrieveParams

All Implemented Interfaces:

com.lithic.api.core.Params
```
public final class AuthRuleV2BacktestRetrieveParams
 implements Params
                    
```
Returns the backtest results of an Auth rule (if available).
Backtesting is an asynchronous process that requires time to complete. If a customer retrieves the backtest results using this endpoint before the report is fully generated, the response will return null for results.current_version and results.draft_version. Customers are advised to wait for the backtest creation process to complete (as indicated by the webhook event auth_rules.backtest_report.created) before retrieving results from this endpoint.
Backtesting is an asynchronous process, while the backtest is being processed, results will not be available which will cause results.current_version and results.draft_version objects to contain null. The entries in results will also always represent the configuration of the rule at the time requests are made to this endpoint. For example, the results for current_version in the served backtest report will be consistent with which version of the rule is currently activated in the respective event stream, regardless of which version of the rule was active in the event stream at the time a backtest is requested.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`AuthRuleV2BacktestRetrieveParams.Builder`	A builder for AuthRuleV2BacktestRetrieveParams.

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`	`authRuleToken()`
`final Optional<String>`	`authRuleBacktestToken()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final AuthRuleV2BacktestRetrieveParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`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 AuthRuleV2BacktestRetrieveParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of AuthRuleV2BacktestRetrieveParams.

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

- Constructor Detail
- Method Detail
  - authRuleToken
```
 final String authRuleToken()
```
  - authRuleBacktestToken
```
 final Optional<String> authRuleBacktestToken()
```
  - _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 AuthRuleV2BacktestRetrieveParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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 AuthRuleV2BacktestRetrieveParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of AuthRuleV2BacktestRetrieveParams.
    The following fields are required:
    .authRuleToken()