Class DeadLetterQueueApi

DeadLetterQueueApi - object-oriented interface export DeadLetterQueueApi

Hierarchy (view full)

BaseAPI
- DeadLetterQueueApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiDeadletterPurgeDlqPost apiDeadletterReplayPost

Constructors

constructor

new DeadLetterQueueApi(configuration?, basePath?, axios?): DeadLetterQueueApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DeadLetterQueueApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiDeadletterPurgeDlqPost

apiDeadletterPurgeDlqPost(purgeRequestModel?, options?): Promise<AxiosResponse<void, any>>
summary Purges messages older than the specified number of days from the dead-letter queue.
Parameters
- OptionalpurgeRequestModel: PurgeRequestModel
  The request model containing the number of days ago to start purging.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof DeadLetterQueueApi
- Defined in src/api/api.ts:15847

apiDeadletterReplayPost

apiDeadletterReplayPost(replayRequestModel?, options?): Promise<AxiosResponse<void, any>>
summary Replays messages from the dead-letter queue based on the specified message IDs or a time range.
Parameters
- OptionalreplayRequestModel: ReplayRequestModel
  The request model containing the time range or specific message IDs to replay.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof DeadLetterQueueApi
- Defined in src/api/api.ts:15859