INTERFACE
CatalogQueryProvider
link GraphQL Schema definition
- interface CatalogQueryProvider {
- # Provider name, expected to be the same as the field name used to access this
- # provider, possibly with case differences
- String! :
- # Information about this provider
- CatalogProviderInfo! :
- # Optional support for querying catalog items across catalogs
- #
- # Arguments
- # after: [Not documented]
- # catalogId: Optionally filter by catalogId
- # catalogItemId: Optionally filter by catalogItemIds
- # depreciationStatus: filter catalog items by depreciation status
- # filter: filter applying only to first-level catalog item fields
- # first: [Not documented]
- # provider: optionally filter by provider
- (
- String, :
- String!], : [
- String!], : [
- CatalogItemDepreciationStatus!], : [
- QueryFilter, :
- Int, :
- String!] : [
- ): CatalogItemConnection
- # Query available catalogs
- #
- # Arguments
- # after: [Not documented]
- # catalogId: Optionally filter by catalogId
- # filter: [Not documented]
- # first: [Not documented]
- # provider: optionally filter by provider
- (
- String, :
- String!], : [
- QueryFilter, :
- Int, :
- String!] : [
- ): CatalogConnection!
- # Query entities that are running a copy of the given catalog item
- #
- # Arguments
- # after: Return records after the given cursor, as per GraphQL
- # Relay spec
- # catalogItemProvider: Optionally filter by catalogItem provider
- # catalogItemTags: Identify catalog item by given catalogItem tag
- # keys or tag key/value pairs
- # entityType: Optionally filter by entityType
- # first: Return first N records in a paged response, as per
- # GraphQL Relay spec
- # managementEndpointId: Optionally filter by managementEndpointId
- # (also referenced as cloudAccountId in places)
- # provider: Optionally filter by entity provider
- # region: Optionally filter by entity region
- (
- String, :
- String!], : [
- TagFilterInput!]!, : [
- String!], : [
- Int, :
- String!], : [
- String!], : [
- String!] : [
- ): EntityConnection
- # Query to search deployed entities for any underlying catalog items from which
- # the entities were deployed.
- #
- # For example, the VAC catalog provider uses the MD5 checksum from a pod image to
- # match the MD5 of a catalog item
- # and does this by bulk-reading the MD5 properties of the underlying pod images
- # then doing a bulk lookup.
- #
- # The response is a list of corresponding CatalogItemConnections. Entries in the
- # list will be null if there
- # are no corresponding matches.
- #
- # This provider API is invoked in bulk by the
- # entity.traits.catalogInfo.queryRelatedCatalogItems() query
- #
- # Arguments
- # after: [Not documented]
- # entityId: EntityIds of entities for which we want to search for
- # underlying catalog items
- # first: [Not documented]
- # provider: Filter search for catalog item by provider
- (
- String, :
- EntityId!]!, : [
- Int, :
- String!] : [
- ): [CatalogItemConnection]
- }