Class ReindexService

Reindex service

Hierarchy

  • ReindexService

Constructors

constructor

Properties

httpClient namespace tokenService

Methods

createReindexJob deleteReindexJob getReindexJobs getReindexJobsDetails retryReindexJob

Constructors

constructor

Properties

Private httpClient

httpClient: HttpClient

Private namespace

namespace: string = '/reindex/v1/jobs'

Private tokenService

tokenService: TokensService

Methods

createReindexJob

  • Create reindex job

    Parameters

    Returns Promise<AxiosResponse<IReindexJob, any, {}>>

    job object

deleteReindexJob

  • Delete a reindex job

    Parameters

    • jobId: number

      the id of the job to delete

    Returns Promise<AxiosResponse<{
        message: string;
    }, any, {}>>

    a message indicating the job has been deleted

getReindexJobs

  • Get reindex jobs

    Returns Promise<AxiosResponse<IReindexJob[], any, {}>>

    a list of all reindex jobs, sorted by start date (newest first).

getReindexJobsDetails

  • Get reindex jobs details

    Parameters

    • jobId: number

      the id of the job to get details for

    Returns Promise<AxiosResponse<IReindexItem[], any, {}>>

    full details for a specific job, including the status of individual domains (reindex items).

retryReindexJob

  • Retry a failed reindex job

    Parameters

    • jobId: number

      the id of the job to retry

    Returns Promise<AxiosResponse<{
        message: string;
    }, any, {}>>

    a message indicating the job has been retried

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc