Backstage
    Preparing search index...

    A version of the @backstage/catalog-client#CatalogApi | CatalogApi that requires backend credentials to be passed instead of a token.

    interface CatalogService {
        addLocation(
            location: AddLocationRequest,
            options: CatalogServiceRequestOptions,
        ): Promise<AddLocationResponse>;
        analyzeLocation(
            location: AnalyzeLocationRequest,
            options: CatalogServiceRequestOptions,
        ): Promise<AnalyzeLocationResponse>;
        getEntities(
            request: GetEntitiesRequest | undefined,
            options: CatalogServiceRequestOptions,
        ): Promise<GetEntitiesResponse>;
        getEntitiesByRefs(
            request: GetEntitiesByRefsRequest,
            options: CatalogServiceRequestOptions,
        ): Promise<GetEntitiesByRefsResponse>;
        getEntityAncestors(
            request: GetEntityAncestorsRequest,
            options: CatalogServiceRequestOptions,
        ): Promise<GetEntityAncestorsResponse>;
        getEntityByRef(
            entityRef: string | CompoundEntityRef,
            options: CatalogServiceRequestOptions,
        ): Promise<Entity | undefined>;
        getEntityFacets(
            request: GetEntityFacetsRequest,
            options: CatalogServiceRequestOptions,
        ): Promise<GetEntityFacetsResponse>;
        getLocationByEntity(
            entityRef: string | CompoundEntityRef,
            options: CatalogServiceRequestOptions,
        ): Promise<Location | undefined>;
        getLocationById(
            id: string,
            options: CatalogServiceRequestOptions,
        ): Promise<Location | undefined>;
        getLocationByRef(
            locationRef: string,
            options: CatalogServiceRequestOptions,
        ): Promise<Location | undefined>;
        getLocations(
            request: {} | undefined,
            options: CatalogServiceRequestOptions,
        ): Promise<GetLocationsResponse>;
        queryEntities(
            request: QueryEntitiesRequest | undefined,
            options: CatalogServiceRequestOptions,
        ): Promise<QueryEntitiesResponse>;
        refreshEntity(
            entityRef: string,
            options: CatalogServiceRequestOptions,
        ): Promise<void>;
        removeEntityByUid(
            uid: string,
            options: CatalogServiceRequestOptions,
        ): Promise<void>;
        removeLocationById(
            id: string,
            options: CatalogServiceRequestOptions,
        ): Promise<void>;
        streamEntities(
            request: StreamEntitiesRequest | undefined,
            options: CatalogServiceRequestOptions,
        ): AsyncIterable<Entity[]>;
        validateEntity(
            entity: Entity,
            locationRef: string,
            options: CatalogServiceRequestOptions,
        ): Promise<ValidateEntityResponse>;
    }

    Hierarchy (View Summary)

    Index

    Methods