Class CatalogUnprocessedEntitiesClient

Default API implementation for the Catalog Unprocessed Entities plugin

Implements

CatalogUnprocessedEntitiesApi

Index

Constructors

Methods

delete failed pending

Constructors

constructor

new CatalogUnprocessedEntitiesClient(
    discovery: { getBaseUrl(pluginId: string): Promise<string> },
    fetchApi?: {
        fetch: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
    },
): CatalogUnprocessedEntitiesClient
Parameters
- discovery: { getBaseUrl(pluginId: string): Promise<string> }
- OptionalfetchApi: {
      fetch: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      };
  }
  - fetch: {
    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
Returns CatalogUnprocessedEntitiesClient
- Defined in plugins/catalog-unprocessed-entities-common/src/api/api.ts:74

Methods

delete

delete(
entityId: string,
options?: UnprocessedEntitiesRequestOptions,
): Promise<void>
Deletes an entity from the refresh_state table
Parameters
- entityId: string
  The ID of the entity to delete
- Optionaloptions: UnprocessedEntitiesRequestOptions
  Additional options
Returns Promise<void>
Implementation of CatalogUnprocessedEntitiesApi.delete
- Defined in plugins/catalog-unprocessed-entities-common/src/api/api.ts:114

failed

failed(
options?: UnprocessedEntitiesRequestOptions,
): Promise<CatalogUnprocessedEntitiesApiResponse>
Returns a list of entities with state 'failed'
Parameters
- Optionaloptions: UnprocessedEntitiesRequestOptions
  Additional options
Returns Promise<CatalogUnprocessedEntitiesApiResponse>
Implementation of CatalogUnprocessedEntitiesApi.failed
- Defined in plugins/catalog-unprocessed-entities-common/src/api/api.ts:108

pending

pending(
options?: UnprocessedEntitiesRequestOptions,
): Promise<CatalogUnprocessedEntitiesApiResponse>
Returns a list of entities with state 'pending'
Parameters
- Optionaloptions: UnprocessedEntitiesRequestOptions
  Additional options
Returns Promise<CatalogUnprocessedEntitiesApiResponse>
Implementation of CatalogUnprocessedEntitiesApi.pending
- Defined in plugins/catalog-unprocessed-entities-common/src/api/api.ts:102