OBJECT
Subscription
The subscription root of Snowflake's GraphQL interface.
Snowflake provides two types of definition in its framework queries:
onVerbObjectonObjectVerb(UUID!)
onVerbObject subscriptions are global, and are broadcast whenever the corresponding mutation occurs. These can be used to subscribe to mutations that are triggered by the client.
onObjectVerb(UUID!) subscriptions are primarily used by scraping, installation, and orchestration mutations. These are used to subscribe to events happening on a specific long-existing object that may or may not be the result of a client request.
There is some subtlely in the different types of subscriptions that one should be aware about.
For example, onStopEmulation is broadcast when the stopEmulation mutation responds to some client. However, onEmulationStop is broadcast when the emulation process exits. Hence, onStopEmulation may never be broadcast, even if onEmulationStop was.
In most cases, it is more useful to subscribe to the onObjectVerb subscription for an object whenever feasible.
- type Subscription {
- # A subscription for when a scrape context step occurs.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): ScrapeContextStepPayload!
- # A subscription for when a scrape context completes.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): ScrapeContextCompletePayload!
- # A subscription for when a scrape context is deleted.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): DeleteScrapeContextPayload!
- # A subscription for when a scrape context is cancelled.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): CancelScrapeContextPayload!
- # A subscription for when a scrape context is applied to a game.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): ApplyScrapeContextPayload!
- # A subscription for when a game installation step occurs.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): InstallationStepPayload!
- # A subscription for when a game installation completes.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): InstallationCompletePayload!
- # A subscription for when a game installation is cancelled.
- #
- # Arguments
- # jobId: [Not documented]
- (: UUID!): InstallationCancelledPayload!
- # A subscription for the cleanupEmulation mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): EmulationInstancePayload!
- # A subscription for the startEmulation mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): EmulationInstancePayload!
- # A subscription for when an emulation ends. The payload will be the same as in
- # the corresponding `onEmulationStart` subscription.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): EmulationInstancePayload!
- # A subscription for the setupEmulationEnvironment mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): EmulationInstancePayload!
- # A subscription for the compileEmulationConfiguration mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (
- : UUID!
- ): EmulationInstancePayload!
- # A subscription for the restoreEmulationSave mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): EmulationInstancePayload!
- # A subscription for the persistEmulationSave mutation.
- #
- # Arguments
- # instanceId: [Not documented]
- (: UUID!): PersistEmulationSavePayload!
- # Subscription for the createGame mutation.
- : GamePayload!
- # Subscription for the deleteGame mutation.
- : GamePayload!
- # Subscription for the updateGameMetadata mutation.
- : UpdateGameMetadataPayload!
- # Subscription for the deleteGameMetadata mutation.
- : DeleteGameMetadataPayload!
- # Subscription for the createScrapeContext mutation.
- : CreateScrapeContextPayload!
- # Subscription for the cancelScrapeContext mutation.
- : CancelScrapeContextPayload!
- # Subscription for the deleteScrapeContext mutation.
- : DeleteScrapeContextPayload!
- # Subscription for the nextScrapeContextStep mutation.
- : ScrapeContextPayload!
- # Subscription for the exhaustScrapeContextSteps mutation.
- : ScrapeContextCompletePayload!
- # Subscription for the applyScrapeContext mutation.
- : ApplyScrapeContextPayload!
- # Subscription for the createValidation mutation.
- : CreateValidationPayload!
- # Subscription for the createInstallation mutation.
- : CreateInstallationPayload!
- # Subscription for the nextInstallationStep mutation.
- : InstallationPayload!
- # Subscription for the exhaustInstallationSteps mutation.
- : InstallationCompletePayload!
- # Subscription for the cancelInstallation mutation.
- : InstallationCancelledPayload!
- # Subscription for the createInputProfile mutation.
- : InputProfilePayload!
- # Subscription for the updateInputProfile mutation.
- : InputProfilePayload!
- # Subscription for the updateGameConfigurationValues mutation.
- : UpdateGameConfigurationValuePayload!
- # Subscription for the deleteGameConfiguration mutation.
- : DeleteGameConfigurationPayload!
- # Subscription for the updatePluginConfigurationValues mutation.
- : UpdatePluginConfigurationValuePayload!
- # Subscription for the createSaveProfile mutation.
- : CreateSaveProfilePayload!
- # Subscription for the deleteSaveProfile mutation.
- : DeleteSaveProfilePayload!
- # Subscription for the createEmulationInstance mutation.
- : EmulationInstancePayload!
- # Subscription for the cleanupEmulation mutation.
- : CleanupEmulationPayload!
- # Subscription for the setupEmulationEnvironment mutation.
- : EmulationInstancePayload!
- # Subscription for the compileEmulationConfiguration mutation.
- : EmulationInstancePayload!
- # Subscription for the restoreEmulationSave mutation.
- : EmulationInstancePayload!
- # Subscription for the startEmulation mutation.
- : EmulationInstancePayload!
- # Subscription for the stopEmulation mutation.
- : EmulationInstancePayload!
- # Subscription for the persistEmulationSave mutation.
- : PersistEmulationSavePayload!
- # Subscription for the updatePortDevice mutation.
- : UpdatePortPayload!
- # Subscription for the clearPortDevice mutation.
- : ClearPortPayload!
- }
This element is not required by anyone