@backstage/catalog-client

Home > @backstage/catalog-client

An isomorphic client for the catalog backend

Classes

Class	Description
CatalogClient	A frontend and backend compatible client for communicating with the Backstage software catalog.

Interfaces

Interface	Description
CatalogApi	A client for interacting with the Backstage software catalog through its API.
CatalogRequestOptions	Options you can pass into a catalog request for additional information.
GetEntitiesByRefsRequest	The request type for CatalogClient.getEntitiesByRefs().
GetEntitiesByRefsResponse	The response type for CatalogClient.getEntitiesByRefs().
GetEntitiesRequest	The request type for CatalogClient.getEntities().
GetEntitiesResponse	The response type for CatalogClient.getEntities().
GetEntityAncestorsRequest	The request type for CatalogClient.getEntityAncestors().
GetEntityAncestorsResponse	The response type for CatalogClient.getEntityAncestors().
GetEntityFacetsRequest	The request type for CatalogClient.getEntityFacets().
GetEntityFacetsResponse	The response type for CatalogClient.getEntityFacets().

Variables

Variable	Description
CATALOG_FILTER_EXISTS	This symbol can be used in place of a value when passed to filters in e.g. CatalogClient.getEntities(), to signify that you want to filter on the presence of that key no matter what its value is.
ENTITY_STATUS_CATALOG_PROCESSING_TYPE	The entity status.items[].type for the status of the processing engine in regards to an entity.

Type Aliases

Type Alias	Description
AddLocationRequest	The request type for CatalogClient.addLocation().
AddLocationResponse	The response type for CatalogClient.addLocation().
EntityFieldsQuery	A set of dot-separated paths into an entity's keys, showing what parts of an entity to include in a response, and excluding all others.
EntityFilterQuery	A key-value based filter expression for entities.
EntityOrderQuery	Dot-separated field based ordering directives, controlling the sort order of the output entities.
Location_2	Entity location for a specific entity.
QueryEntitiesCursorRequest	A request type for CatalogClient.queryEntities(). The method takes this type in a pagination request, following the initial request.
QueryEntitiesInitialRequest	A request type for CatalogClient.queryEntities(). The method takes this type in an initial pagination request, when requesting the first batch of entities. The properties filter, sortField, query and sortFieldOrder, are going to be immutable for the entire lifecycle of the following requests.
QueryEntitiesRequest	The request type for CatalogClient.queryEntities().
QueryEntitiesResponse	The response type for CatalogClient.queryEntities().
ValidateEntityResponse	The response type for CatalogClient.validateEntity()