CatalogClient
Home > @backstage/catalog-client
> CatalogClient
A frontend and backend compatible client for communicating with the Backstage software catalog.
Signature:
class CatalogClient implements CatalogApi
Implements: CatalogApi
Constructors
Constructor |
Modifiers |
Description |
---|---|---|
Constructs a new instance of the |
Methods
Method |
Modifiers |
Description |
---|---|---|
Registers a new location. | ||
Lists catalog entities. | ||
Gets a batch of entities, by their entity refs. | ||
Gets entity ancestor information, i.e. the hierarchy of parent entities whose processing resulted in a given entity appearing in the catalog. | ||
Gets a single entity from the catalog by its ref (kind, namespace, name) triplet. | ||
Gets a summary of field facets of entities in the catalog. | ||
Gets a location associated with an entity. | ||
Gets a registered location by its ID. | ||
Gets a registered location by its ref. | ||
Gets paginated entities from the catalog. | ||
Refreshes (marks for reprocessing) an entity in the catalog. | ||
Removes a single entity from the catalog by entity UID. | ||
Removes a registered Location by its ID. | ||
Validate entity and its location. |