` | `true` | | Either the max number of retry attempts to make or an array containing retry delays between each attempt. If a numeric value is passed in, the `delay` argument is required. |
| delay | `numeric` | `false` | | The delay to use for each of the `attempts`. This argument is required if `attempts` is a numeric value. If `attempts` is an array, this value is ignored. |
| predicate | `function` | `false` | | The predicate function to call to determine if a retry should be attempted.
This function is only called if there are configured retries available.
To retry a request, this function should return true.
It is passed the response and request as parameters.
Additionally, the request can be modified in this method for the next retry attempt.
|
**Return**: `HyperRequest`
### `getRetries`
Returns the current retry configuration which is an array of delay times. A request that needs to be retried will be retried up to the amount of items in this array. This array can be set using the `retry` method.
{% hint style="warning" %}
In most cases, you do not need to interact with this method directly. Use the `retry` method instead.
{% endhint %}
| Name | Type | Required | Default | Description |
| ------------ | ---- | -------- | ------- | ----------- |
| No arguments | | | | |
**Return**: `array`
### `getCurrentRequestCount`
Returns the current request count. Defaults to `1`. The only time this will increase is if `retries` have been configured for the request.
| Name | Type | Required | Default | Description |
| ------------ | ---- | -------- | ------- | ----------- |
| No arguments | | | | |
**Return**: `numeric`
### `getRetryPredicate`
Returns the current callback function that is called to decide if a request should be retried. This is only called if there are available retries left.
This callback is passed the response and the request as parameters.
A request will be retried if this function returns `true`.
In this function, the passed in request can be modified for the next retry.
{% hint style="warning" %}
In most cases, you do not need to interact with this method directly. Use the `retry` method instead.
{% endhint %}
| Name | Type | Required | Default | Description |
| ------------ | ---- | -------- | ------- | ----------- |
| No arguments | | | | |
**Return**: `numeric`
### `setProperties`
Quickly set many request properties using a struct. The key should be the name of one of the properties on the request, e.g. `url`, `headers`, `method`, `body`.
| Name | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| properties | struct | true | | A struct of properties to set. Each property name will be set on the request. Properties that don't exist on the request will throw an error. |
**Return**: `HyperRequest`
### `setHttpClient`
Sets the [HTTP Client](https://hyper.ortusbooks.com/customizing-hyper/custom-http-clients) to use for the request. The client should conform to the `HyperHttpClientInterface` (though it does not need to use the `implements` keyword).
| Name | Type | Required | Default | Description |
| ---------- | -------------------------- | -------- | ------- | -------------------------------------- |
| httpClient | `HyperHttpClientInterface` | `true` | | The httpClient to use for the request. |
**Return**: `HyperRequest`
### `setInterceptorService`
Sets the [ColdBox Interceptor Service](https://coldbox.ortusbooks.com/the-basics/interceptors) to announce request and response interception points. A noop option is provided in the `init` for non-ColdBox usage.
| Name | Type | Required | Default | Description |
| ------------------ | ---- | -------- | ------- | ----------------------------------------------- |
| interceptorService | any | `true` | | The interceptor service to use for the request. |
**Return**: `HyperRequest`
### `setAsyncManager`
Sets the [ColdBox AsyncManager](https://coldbox.ortusbooks.com/digging-deeper/promises-async-programming) to send requests asynchronously. A noop option is provided in the `init` for non-ColdBox usage.
| Name | Type | Required | Default | Description |
| ------------ | ---- | -------- | ------- | ---------------------------------------- |
| asyncManager | any | `true` | | The asyncManager to use for the request. |
**Return**: `HyperRequest`
### `getMemento`
Returns a struct representing this `HyperRequest`.
| Name | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | ------------------------------------------------------ |
| excludes | `array` | `false` | `[]` | An array of keys to exclude from the returned memento. |
**Return**:
```json
{
"requestID" : getRequestID(),
"baseUrl" : getBaseUrl(),
"url" : getUrl(),
"fullUrl" : getFullUrl(),
"method" : getMethod(),
"queryParams" : getQueryParams(),
"headers" : getHeaders(),
"cookies" : getCookies(),
"files" : getFiles(),
"bodyFormat" : getBodyFormat(),
"body" : getBody(),
"referrer" : isNull( variables.referrer ) ? "" : variables.referrer,
"throwOnError" : getThrowOnError(),
"timeout" : getTimeout(),
"maximumRedirects" : getMaximumRedirects(),
"authType" : getAuthType(),
"username" : getUsername(),
"password" : getPassword(),
"clientCert" : isNull( variables.clientCert ) ? "" : variables.clientCert,
"clientCertPassword" : isNull( variables.clientCertPassword ) ? "" : variables.clientCertPassword,
"domain" : getDomain(),
"workstation" : getWorkstation(),
"resolveUrls" : getResolveUrls(),
"encodeUrl" : getEncodeUrl(),
"retries" : getRetries(),
"currentRequestCount" : getCurrentRequestCount()
};
```
### `debug`
Creates a debug representation of the HTTP request for the current HTTP client.
{% hint style="danger" %}
**Throws**: `NoUrlException` when no URL is set.
{% endhint %}
| Name | Type | Required | Default | Description |
| ------------ | ---- | -------- | ------- | ----------- |
| No arguments | | | | |
**Return**: Dependent on the configured HTTP Client. See specific HTTP Client documentation for details.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://hyper.ortusbooks.com/making-requests/hyperrequest.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.