Classes

Rate this page:

Interfaces

MetricSourcesPayload

Property NameTypeDescription
metricSourcesArray<CompassMetricSource>
pageInfoPageInfo

GetOptions

Options for what to include in search results

Property NameTypeDescription
includeEventSourcesBooleanInclude event sources in the results
includeLinksBooleanInclude links in the results
includeMetricSourcesBooleanInclude metric sources in the results

GetComponentInput

Property NameTypeDescription
componentIdStringComponent id of component to retrieve
optionsGetOptionsOptions for what to include in search results

GetMetricDefinitionsOptions

Property NameTypeDescription
includeMetricSourcesBooleanInclude metric sources in the results

GetMetricDefinitionsInput

Property NameTypeDescription
afterStringReturns results after the specified cursor.
cloudIdStringThe cloud ID of the site to query for metric definitions on.
firstNumberThe number of results to return in the query. The default is 10.
optionsGetMetricDefinitionsOptionsOptions for what to include in search results

SearchComponentsInput

Property NameTypeDescription
cloudIdStringCloud id of Compass site that the Component exists on
optionsGetOptionsOptions for what to include in search results.
queryCompassSearchComponentQueryThe query to find components

GetComponentByExternalAliasInput

Property NameTypeDescription
cloudIdStringCloud id of Compass site that the Component exists on
externalIdStringThe ID of the component in an external system
externalSourceStringThe external system hosting the component
optionsGetOptionsOptions for what to include in search results

AddEventSourceInput

Property NameTypeDescription
componentIdStringComponent id that created event source will be attached to
eventSourceCreateEventSourceInputEvent source to create

UpdateEventSourcesInput

Property NameTypeDescription
componentIdString
newEventSourcesArray<CreateEventSourceInput>
oldEventSourcesArray<EventSource>

Relationship

Property NameTypeDescription
nodeIdStringThe end node of relationship.
typeDependsOnThe type of relationship.

Component

Property NameTypeDescription
dataManagerUpdateCompassComponentDataManagerMetadataInput | DataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
eventSourcesArray<EventSource>The event sources associated to the component.
externalAliasesArray<CompassExternalAlias>A collection of aliases that represent the component in external systems.
fieldsRecord<String, Unknown>A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.
idStringThe unique identifier (ID) of the component.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<Link>A collection of links to other entities on the internet.
metricSourcesArray<CompassMetricSource>The metric source associated to the component.
nameStringThe name of the component.
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.
typeCompassComponentTypeThe type of the component.

BaseComponentInput

Property NameTypeDescription
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
externalAliasCompassExternalAliasInputThe event sources associated to the component.
fieldsRecord<String, Array<String>>A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<CreateLinkInput>A collection of links to other entities on the internet.
nameStringThe name of the component.
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.

GqlError

Error stemming from Graphql Gateway schema.

Property NameTypeDescription
extensionsGqlErrorExtensions
messageStringA human readable error message.

GqlErrorExtensions

Property NameTypeDescription
classificationStringApplication specific error type.
errorSourceStringApplication layer in which the error occurred.

MutationErrorExtensions

Property NameTypeDescription
errorTypeStringApplication specific error type.
statusCodeNumberApplication layer in which the error occurred.

MutationError

Error stemming from Compass Catalog.

Property NameTypeDescription
extensionsMutationErrorExtensions
messageStringA human readable error message.

SdkError

Error that gets returned from requests.

Property NameTypeDescription
errorSourceStringApplication layer in which the error occurred.
errorTypeStringApplication specific error type.
messageStringA human readable error message.
statusCodeNumberA numerical code (such as a HTTP status code) representing the error category

SyncComponentByExternalAliasInputOptions

Property NameTypeDescription
createComponentIfNotFoundBooleanWhen true, if a component is not found by the external alias, create a new component. When false, if a component is not found by external alias, return an error message. Defaults to true.

SyncComponentByExternalAliasInput

Property NameTypeDescription
cloudIdStringId of the Compass site to search for the component/create the component on if it does not already exist.
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
eventSourcesArray<CreateEventSourceInput | EventSource>The collection of event sources to sync on the component. If a given event source does not exist on the component, it gets created. If an event source exists in Compass but not in the collection defined here, the event source on Compass gets deleted. If an empty list or null is supplied, the existing event sources on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of event sources on the Compass component.
externalAliasCompassExternalAliasInputExternal alias to search for the component by.
fieldsRecord<String, Array<String>>A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<Link | CreateLinkInput>The collection of links to sync on the component. If a given link does not exist on the component, it gets created. If a link exists in Compass but not in the collection defined here, the link on Compass gets deleted. If an empty list or null is supplied, the existing links on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of links on the Compass component.
nameStringThe name to apply to the component.
optionsSyncComponentByExternalAliasInputOptionsOptions for how to handle sync behavior.
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.
typeCompassComponentTypeThe type to apply to the component.

CreateComponentInput

Property NameTypeDescription
cloudIdStringId of the Compass site to create the component on.
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
externalAliasCompassExternalAliasInputThe event sources associated to the component.
fieldsRecord<String, Array<String>>A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<CreateLinkInput>A collection of links to other entities on the internet.
nameStringThe name of the component.
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.
typeCompassComponentTypeThe type of the component.

UpdateComponentInput

Property NameTypeDescription
currentComponentComponentThe existing component to be updated. This saves one call to getComponent.
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
eventSourcesArray<CreateEventSourceInput | EventSource>The updated collection of eventSources to assign to the component.
externalAliasCompassExternalAliasInputThe event sources associated to the component.
fieldsRecord<String, Array<String>>A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.
idStringThe ID of the component being updated.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<Link | CreateLinkInput>The updated collection of links to assign to the component.
nameStringThe name of the component.
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.

EventSourcesPayload

Property NameTypeDescription
eventSourcesArray<EventSource>Collection of event sources returned by a request.

EventSourcePayload

Property NameTypeDescription
eventSourceEventSourceEvent source returned by a request.

LabelsPayload

Property NameTypeDescription
labelNamesArray<CompassComponentLabel>Collection of labels returned by a request.

ComponentPayload

Property NameTypeDescription
componentComponentComponent details returned by a request.

MetricDefinitionPayload

Property NameTypeDescription
metricDefinitionCompassMetricDefinitionMetric definition returned by a request

MetricDefinitionsPayload

Property NameTypeDescription
metricDefinitionsArray<CompassMetricDefinition>Metric definitions returned by a request
pageInfoPageInfo

ExternalAliasPayload

Property NameTypeDescription
externalAliasCompassExternalAliasExternal alias returned by a request.

LinkPayload

Property NameTypeDescription
linkCompassLinkComponent link returned by a request.

RelationshipPayload

Property NameTypeDescription
relationshipCompassRelationshipComponent relationship returned by a request.

IdPayload

Property NameTypeDescription
idStringId returned by a request.

MetricSourceIdPayload

Property NameTypeDescription
metricSourceIdStringId returned by a request.

SearchComponentsPayload

Property NameTypeDescription
componentsArray<Component>Component details returned by a request.
pageInfoPageInfo

GetEventSourceInputOptions

Property NameTypeDescription
eventsQueryCompassEventsInEventSourceQuery
includeEventsBoolean

GetEventSourceInput

Property NameTypeDescription
cloudIdString
eventTypeCompassEventType
externalEventSourceIdString
optionsGetEventSourceInputOptions

Rate this page: