Interface CatalogUnprocessedEntitiesApi

Interface for the CatalogUnprocessedEntitiesApi.

Deprecated

Use the type imported from @backstage/plugin-catalog-unprocessed-entities-common instead.

interface CatalogUnprocessedEntitiesApi {
    delete(
        entityId: string,
        options?: UnprocessedEntitiesRequestOptions,
    ): Promise<void>;
    failed(
        options?: UnprocessedEntitiesRequestOptions,
    ): Promise<CatalogUnprocessedEntitiesApiResponse>;
    pending(
        options?: UnprocessedEntitiesRequestOptions,
    ): Promise<CatalogUnprocessedEntitiesApiResponse>;
}

Hierarchy (View Summary)

CatalogUnprocessedEntitiesApi
- CatalogUnprocessedEntitiesApi

Index

Methods

delete failed pending

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>
Inherited from CatalogUnprocessedEntitiesApi.delete
- Defined in plugins/catalog-unprocessed-entities-common/src/api/api.ts:57

failed

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

pending

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