Function DeadLetterQueueApiFactory

DeadLetterQueueApi - factory interface export

  • DeadLetterQueueApiFactory(configuration?, basePath?, axios?): {
        apiDeadletterPurgeDlqPost(purgeRequestModel?: PurgeRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDeadletterReplayPost(replayRequestModel?: ReplayRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiDeadletterPurgeDlqPost(purgeRequestModel?: PurgeRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDeadletterReplayPost(replayRequestModel?: ReplayRequestModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    }

    • apiDeadletterPurgeDlqPost:function
      • apiDeadletterPurgeDlqPost(purgeRequestModel?, options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

    • apiDeadletterReplayPost:function
      • apiDeadletterReplayPost(replayRequestModel?, options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

Settings

Member Visibility