<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta http-equiv=x-ua-compatible content="ie=edge"><meta name=lang:clipboard.copy content="Copy to clipboard"><meta name=lang:clipboard.copied content="Copied to clipboard"><meta name=lang:search.language content=en><meta name=lang:search.pipeline.stopwords content=True><meta name=lang:search.pipeline.trimmer content=True><meta name=lang:search.result.none content="No matching documents"><meta name=lang:search.result.one content="1 matching document"><meta name=lang:search.result.other content="# matching documents"><meta name=lang:search.tokenizer content=[\s\-]+><link rel="shortcut icon" href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.0.4, mkdocs-material-4.4.2"><title>Thrift API - Eclipse Hawk</title><link rel=stylesheet href=../../assets/stylesheets/application.30686662.css><link rel=stylesheet href=../../assets/stylesheets/application-palette.a8b3c06d.css><meta name=theme-color content=#7e57c2><script src=../../assets/javascripts/modernizr.74668098.js></script><link href=https://fonts.gstatic.com rel=preconnect crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"><style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style><link rel=stylesheet href=../../assets/fonts/material-icons.css><link rel=stylesheet href=../../stylesheets/extra.css><!-- FAVICON --><link rel=apple-touch-icon sizes=180x180 href=/img/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=/img/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/img/favicon-16x16.png><link rel=manifest href=/img/site.webmanifest><link rel=mask-icon href=/img/safari-pinned-tab.svg color=#5bbad5><link rel="shortcut icon" href=/img/favicon.ico><meta name=msapplication-TileColor content=#b91d47><meta name=msapplication-config content=/img/browserconfig.xml><meta name=theme-color content=#ffffff></head> <body dir=ltr data-md-color-primary=deep-purple data-md-color-accent=deep-purple> <svg class=md-svg> <defs> </defs> </svg> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay data-md-component=overlay for=__drawer></label> <a href=#services tabindex=1 class=md-skip> Skip to content </a> <header class=md-header data-md-component=header> <nav class="md-header-nav md-grid"> <div class=md-flex> <div class="md-flex__cell md-flex__cell--shrink"> <a href=../.. title="Eclipse Hawk" class="md-header-nav__button md-logo"> <img src=../../assets/images/hawk-logo-white.svg width=24 height=24> </a> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--menu md-header-nav__button" for=__drawer></label> </div> <div class="md-flex__cell md-flex__cell--stretch"> <div class="md-flex__ellipsis md-header-nav__title" data-md-component=title> <span class=md-header-nav__topic> Eclipse Hawk </span> <span class=md-header-nav__topic> Thrift API </span> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <label class="md-icon md-icon--search md-header-nav__button" for=__search></label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=query data-md-state=active> <label class="md-icon md-search__icon" for=__search></label> <button type=reset class="md-icon md-search__icon" data-md-component=reset tabindex=-1> &#xE5CD; </button> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=result> <div class=md-search-result__meta> Type to start searching </div> <ol class=md-search-result__list></ol> </div> </div> </div> </div> </div> </div> <div class="md-flex__cell md-flex__cell--shrink"> <div class=md-header-nav__source> <a href=https://git.eclipse.org/c/hawk/hawk.git/ title="Go to repository" class=md-source data-md-source> <div class=md-source__repository> Git repository @ Eclipse </div> </a> </div> </div> </div> </nav> </header> <div class=md-container> <main class=md-main role=main> <div class="md-main__inner md-grid" data-md-component=container> <div class="md-sidebar md-sidebar--primary" data-md-component=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary" data-md-level=0> <label class="md-nav__title md-nav__title--site" for=__drawer> <a href=../.. title="Eclipse Hawk" class="md-nav__button md-logo"> <img src=../../assets/images/hawk-logo-white.svg width=48 height=48> </a> Eclipse Hawk </label> <div class=md-nav__source> <a href=https://git.eclipse.org/c/hawk/hawk.git/ title="Go to repository" class=md-source data-md-source> <div class=md-source__repository> Git repository @ Eclipse </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. title=Home class=md-nav__link> Home </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-2 type=checkbox id=nav-2> <label class=md-nav__link for=nav-2> Basic use </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-2> Basic use </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../basic-use/installation/ title=Installation class=md-nav__link> Installation </a> </li> <li class=md-nav__item> <a href=../../basic-use/core-concepts/ title="Core concepts" class=md-nav__link> Core concepts </a> </li> <li class=md-nav__item> <a href=../../basic-use/examples-xmi/ title="Examples (XMI)" class=md-nav__link> Examples (XMI) </a> </li> <li class=md-nav__item> <a href=../../basic-use/examples-modelio/ title="Examples (Modelio)" class=md-nav__link> Examples (Modelio) </a> </li> <li class=md-nav__item> <a href=../../basic-use/papyrus/ title="Papyrus UML support" class=md-nav__link> Papyrus UML support </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-3 type=checkbox id=nav-3> <label class=md-nav__link for=nav-3> Advanced use </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-3> Advanced use </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced-use/graph-as-emf/ title="Graph as EMF model" class=md-nav__link> Graph as EMF model </a> </li> <li class=md-nav__item> <a href=../../advanced-use/advanced-props/ title="Advanced properties" class=md-nav__link> Advanced properties </a> </li> <li class=md-nav__item> <a href=../../advanced-use/meta-queries/ title="Meta-level queries" class=md-nav__link> Meta-level queries </a> </li> <li class=md-nav__item> <a href=../../advanced-use/temporal-queries/ title="Temporal queries" class=md-nav__link> Temporal queries </a> </li> <li class=md-nav__item> <a href=../../advanced-use/oomph/ title="Oomph and Hawk" class=md-nav__link> Oomph and Hawk </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-4 type=checkbox id=nav-4 checked> <label class=md-nav__link for=nav-4> Server </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-4> Server </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../architecture/ title=Architecture class=md-nav__link> Architecture </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-toggle md-nav__toggle" data-md-toggle=toc type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> Thrift API </label> <a href=./ title="Thrift API" class="md-nav__link md-nav__link--active"> Thrift API </a> <nav class="md-nav md-nav--secondary"> <label class=md-nav__title for=__toc>Table of contents</label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#services class=md-nav__link> Services </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hawk class=md-nav__link> Hawk </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hawkcreateinstance class=md-nav__link> Hawk.createInstance </a> </li> <li class=md-nav__item> <a href=#hawklistbackends class=md-nav__link> Hawk.listBackends </a> </li> <li class=md-nav__item> <a href=#hawklistplugins class=md-nav__link> Hawk.listPlugins </a> </li> <li class=md-nav__item> <a href=#hawklistinstances class=md-nav__link> Hawk.listInstances </a> </li> <li class=md-nav__item> <a href=#hawkremoveinstance class=md-nav__link> Hawk.removeInstance </a> </li> <li class=md-nav__item> <a href=#hawkstartinstance class=md-nav__link> Hawk.startInstance </a> </li> <li class=md-nav__item> <a href=#hawkstopinstance class=md-nav__link> Hawk.stopInstance </a> </li> <li class=md-nav__item> <a href=#hawksyncinstance class=md-nav__link> Hawk.syncInstance </a> </li> <li class=md-nav__item> <a href=#hawkregistermetamodels class=md-nav__link> Hawk.registerMetamodels </a> </li> <li class=md-nav__item> <a href=#hawkunregistermetamodels class=md-nav__link> Hawk.unregisterMetamodels </a> </li> <li class=md-nav__item> <a href=#hawklistmetamodels class=md-nav__link> Hawk.listMetamodels </a> </li> <li class=md-nav__item> <a href=#hawklistquerylanguages class=md-nav__link> Hawk.listQueryLanguages </a> </li> <li class=md-nav__item> <a href=#hawkquery class=md-nav__link> Hawk.query </a> </li> <li class=md-nav__item> <a href=#hawkresolveproxies class=md-nav__link> Hawk.resolveProxies </a> </li> <li class=md-nav__item> <a href=#hawkaddrepository class=md-nav__link> Hawk.addRepository </a> </li> <li class=md-nav__item> <a href=#hawkisfrozen class=md-nav__link> Hawk.isFrozen </a> </li> <li class=md-nav__item> <a href=#hawksetfrozen class=md-nav__link> Hawk.setFrozen </a> </li> <li class=md-nav__item> <a href=#hawkremoverepository class=md-nav__link> Hawk.removeRepository </a> </li> <li class=md-nav__item> <a href=#hawkupdaterepositorycredentials class=md-nav__link> Hawk.updateRepositoryCredentials </a> </li> <li class=md-nav__item> <a href=#hawklistrepositories class=md-nav__link> Hawk.listRepositories </a> </li> <li class=md-nav__item> <a href=#hawklistrepositorytypes class=md-nav__link> Hawk.listRepositoryTypes </a> </li> <li class=md-nav__item> <a href=#hawklistfiles class=md-nav__link> Hawk.listFiles </a> </li> <li class=md-nav__item> <a href=#hawkconfigurepolling class=md-nav__link> Hawk.configurePolling </a> </li> <li class=md-nav__item> <a href=#hawkaddderivedattribute class=md-nav__link> Hawk.addDerivedAttribute </a> </li> <li class=md-nav__item> <a href=#hawkremovederivedattribute class=md-nav__link> Hawk.removeDerivedAttribute </a> </li> <li class=md-nav__item> <a href=#hawklistderivedattributes class=md-nav__link> Hawk.listDerivedAttributes </a> </li> <li class=md-nav__item> <a href=#hawkaddindexedattribute class=md-nav__link> Hawk.addIndexedAttribute </a> </li> <li class=md-nav__item> <a href=#hawkremoveindexedattribute class=md-nav__link> Hawk.removeIndexedAttribute </a> </li> <li class=md-nav__item> <a href=#hawklistindexedattributes class=md-nav__link> Hawk.listIndexedAttributes </a> </li> <li class=md-nav__item> <a href=#hawkgetmodel class=md-nav__link> Hawk.getModel </a> </li> <li class=md-nav__item> <a href=#hawkgetrootelements class=md-nav__link> Hawk.getRootElements </a> </li> <li class=md-nav__item> <a href=#hawkwatchstatechanges class=md-nav__link> Hawk.watchStateChanges </a> </li> <li class=md-nav__item> <a href=#hawkwatchmodelchanges class=md-nav__link> Hawk.watchModelChanges </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#ifcexport class=md-nav__link> IFCExport </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#ifcexportexportasstep class=md-nav__link> IFCExport.exportAsSTEP </a> </li> <li class=md-nav__item> <a href=#ifcexportgetjobs class=md-nav__link> IFCExport.getJobs </a> </li> <li class=md-nav__item> <a href=#ifcexportgetjobstatus class=md-nav__link> IFCExport.getJobStatus </a> </li> <li class=md-nav__item> <a href=#ifcexportkilljob class=md-nav__link> IFCExport.killJob </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#users class=md-nav__link> Users </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#userscreateuser class=md-nav__link> Users.createUser </a> </li> <li class=md-nav__item> <a href=#usersupdateprofile class=md-nav__link> Users.updateProfile </a> </li> <li class=md-nav__item> <a href=#usersupdatepassword class=md-nav__link> Users.updatePassword </a> </li> <li class=md-nav__item> <a href=#usersdeleteuser class=md-nav__link> Users.deleteUser </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#entities class=md-nav__link> Entities </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attributeslot class=md-nav__link> AttributeSlot </a> </li> <li class=md-nav__item> <a href=#commititem class=md-nav__link> CommitItem </a> </li> <li class=md-nav__item> <a href=#containerslot class=md-nav__link> ContainerSlot </a> </li> <li class=md-nav__item> <a href=#credentials class=md-nav__link> Credentials </a> </li> <li class=md-nav__item> <a href=#derivedattributespec class=md-nav__link> DerivedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#effectivemetamodel class=md-nav__link> EffectiveMetamodel </a> </li> <li class=md-nav__item> <a href=#effectivemetamodelmap class=md-nav__link> EffectiveMetamodelMap </a> </li> <li class=md-nav__item> <a href=#file class=md-nav__link> File </a> </li> <li class=md-nav__item> <a href=#hawkattributeremovalevent class=md-nav__link> HawkAttributeRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkattributeupdateevent class=md-nav__link> HawkAttributeUpdateEvent </a> </li> <li class=md-nav__item> <a href=#hawkchangeevent class=md-nav__link> HawkChangeEvent </a> </li> <li class=md-nav__item> <a href=#hawkfileadditionevent class=md-nav__link> HawkFileAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkfileremovalevent class=md-nav__link> HawkFileRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkinstance class=md-nav__link> HawkInstance </a> </li> <li class=md-nav__item> <a href=#hawkmodelelementadditionevent class=md-nav__link> HawkModelElementAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkmodelelementremovalevent class=md-nav__link> HawkModelElementRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkqueryoptions class=md-nav__link> HawkQueryOptions </a> </li> <li class=md-nav__item> <a href=#hawkreferenceadditionevent class=md-nav__link> HawkReferenceAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkreferenceremovalevent class=md-nav__link> HawkReferenceRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkstateevent class=md-nav__link> HawkStateEvent </a> </li> <li class=md-nav__item> <a href=#hawksynchronizationendevent class=md-nav__link> HawkSynchronizationEndEvent </a> </li> <li class=md-nav__item> <a href=#hawksynchronizationstartevent class=md-nav__link> HawkSynchronizationStartEvent </a> </li> <li class=md-nav__item> <a href=#ifcexportjob class=md-nav__link> IFCExportJob </a> </li> <li class=md-nav__item> <a href=#ifcexportoptions class=md-nav__link> IFCExportOptions </a> </li> <li class=md-nav__item> <a href=#indexedattributespec class=md-nav__link> IndexedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidmodelspec class=md-nav__link> InvalidModelSpec </a> </li> <li class=md-nav__item> <a href=#invalidtransformation class=md-nav__link> InvalidTransformation </a> </li> <li class=md-nav__item> <a href=#mixedreference class=md-nav__link> MixedReference </a> </li> <li class=md-nav__item> <a href=#modelelement class=md-nav__link> ModelElement </a> </li> <li class=md-nav__item> <a href=#modelelementtype class=md-nav__link> ModelElementType </a> </li> <li class=md-nav__item> <a href=#modelspec class=md-nav__link> ModelSpec </a> </li> <li class=md-nav__item> <a href=#queryresult class=md-nav__link> QueryResult </a> </li> <li class=md-nav__item> <a href=#queryresultmap class=md-nav__link> QueryResultMap </a> </li> <li class=md-nav__item> <a href=#referenceslot class=md-nav__link> ReferenceSlot </a> </li> <li class=md-nav__item> <a href=#repository class=md-nav__link> Repository </a> </li> <li class=md-nav__item> <a href=#slot class=md-nav__link> Slot </a> </li> <li class=md-nav__item> <a href=#slotmetadata class=md-nav__link> SlotMetadata </a> </li> <li class=md-nav__item> <a href=#slotvalue class=md-nav__link> SlotValue </a> </li> <li class=md-nav__item> <a href=#subscription class=md-nav__link> Subscription </a> </li> <li class=md-nav__item> <a href=#userprofile class=md-nav__link> UserProfile </a> </li> <li class=md-nav__item> <a href=#value class=md-nav__link> Value </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#enumerations class=md-nav__link> Enumerations </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#commititemchangetype class=md-nav__link> CommitItemChangeType </a> </li> <li class=md-nav__item> <a href=#hawkstate class=md-nav__link> HawkState </a> </li> <li class=md-nav__item> <a href=#ifcexportstatus class=md-nav__link> IFCExportStatus </a> </li> <li class=md-nav__item> <a href=#subscriptiondurability class=md-nav__link> SubscriptionDurability </a> </li> <li class=md-nav__item> <a href=#failedquery class=md-nav__link> FailedQuery </a> </li> <li class=md-nav__item> <a href=#hawkinstancenotfound class=md-nav__link> HawkInstanceNotFound </a> </li> <li class=md-nav__item> <a href=#hawkinstancenotrunning class=md-nav__link> HawkInstanceNotRunning </a> </li> <li class=md-nav__item> <a href=#invalidderivedattributespec class=md-nav__link> InvalidDerivedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidindexedattributespec class=md-nav__link> InvalidIndexedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidmetamodel class=md-nav__link> InvalidMetamodel </a> </li> <li class=md-nav__item> <a href=#invalidpollingconfiguration class=md-nav__link> InvalidPollingConfiguration </a> </li> <li class=md-nav__item> <a href=#invalidquery class=md-nav__link> InvalidQuery </a> </li> <li class=md-nav__item> <a href=#unknownquerylanguage class=md-nav__link> UnknownQueryLanguage </a> </li> <li class=md-nav__item> <a href=#unknownrepositorytype class=md-nav__link> UnknownRepositoryType </a> </li> <li class=md-nav__item> <a href=#userexists class=md-nav__link> UserExists </a> </li> <li class=md-nav__item> <a href=#usernotfound class=md-nav__link> UserNotFound </a> </li> <li class=md-nav__item> <a href=#vcsauthenticationfailed class=md-nav__link> VCSAuthenticationFailed </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../api-security/ title="Thrift API security" class=md-nav__link> Thrift API security </a> </li> <li class=md-nav__item> <a href=../deployment/ title=Deployment class=md-nav__link> Deployment </a> </li> <li class=md-nav__item> <a href=../cli/ title="Console client" class=md-nav__link> Console client </a> </li> <li class=md-nav__item> <a href=../eclipse/ title="Eclipse client" class=md-nav__link> Eclipse client </a> </li> <li class=md-nav__item> <a href=../file-config/ title="File-based configuration" class=md-nav__link> File-based configuration </a> </li> <li class=md-nav__item> <a href=../logging/ title=Logging class=md-nav__link> Logging </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-toggle md-nav__toggle" data-md-toggle=nav-5 type=checkbox id=nav-5> <label class=md-nav__link for=nav-5> Developers </label> <nav class=md-nav data-md-component=collapsible data-md-level=1> <label class=md-nav__title for=nav-5> Developers </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../developers/run-from-source/ title="Run GUI from source" class=md-nav__link> Run GUI from source </a> </li> <li class=md-nav__item> <a href=../../developers/server-from-source/ title="Run Server from source" class=md-nav__link> Run Server from source </a> </li> <li class=md-nav__item> <a href=../../developers/plain-maven/ title="Build with plain Maven" class=md-nav__link> Build with plain Maven </a> </li> <li class=md-nav__item> <a href=../../developers/website/ title="Work on the website" class=md-nav__link> Work on the website </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../additional-resources/ title="Additional resources" class=md-nav__link> Additional resources </a> </li> <li class=md-nav__item> <a href=https://www.eclipse.org/forums/index.php/f/442/ title=Forum class=md-nav__link> Forum </a> </li> <li class=md-nav__item> <a href=https://ci.eclipse.org/hawk/ title=Builds class=md-nav__link> Builds </a> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary"> <label class=md-nav__title for=__toc>Table of contents</label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=#services class=md-nav__link> Services </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hawk class=md-nav__link> Hawk </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hawkcreateinstance class=md-nav__link> Hawk.createInstance </a> </li> <li class=md-nav__item> <a href=#hawklistbackends class=md-nav__link> Hawk.listBackends </a> </li> <li class=md-nav__item> <a href=#hawklistplugins class=md-nav__link> Hawk.listPlugins </a> </li> <li class=md-nav__item> <a href=#hawklistinstances class=md-nav__link> Hawk.listInstances </a> </li> <li class=md-nav__item> <a href=#hawkremoveinstance class=md-nav__link> Hawk.removeInstance </a> </li> <li class=md-nav__item> <a href=#hawkstartinstance class=md-nav__link> Hawk.startInstance </a> </li> <li class=md-nav__item> <a href=#hawkstopinstance class=md-nav__link> Hawk.stopInstance </a> </li> <li class=md-nav__item> <a href=#hawksyncinstance class=md-nav__link> Hawk.syncInstance </a> </li> <li class=md-nav__item> <a href=#hawkregistermetamodels class=md-nav__link> Hawk.registerMetamodels </a> </li> <li class=md-nav__item> <a href=#hawkunregistermetamodels class=md-nav__link> Hawk.unregisterMetamodels </a> </li> <li class=md-nav__item> <a href=#hawklistmetamodels class=md-nav__link> Hawk.listMetamodels </a> </li> <li class=md-nav__item> <a href=#hawklistquerylanguages class=md-nav__link> Hawk.listQueryLanguages </a> </li> <li class=md-nav__item> <a href=#hawkquery class=md-nav__link> Hawk.query </a> </li> <li class=md-nav__item> <a href=#hawkresolveproxies class=md-nav__link> Hawk.resolveProxies </a> </li> <li class=md-nav__item> <a href=#hawkaddrepository class=md-nav__link> Hawk.addRepository </a> </li> <li class=md-nav__item> <a href=#hawkisfrozen class=md-nav__link> Hawk.isFrozen </a> </li> <li class=md-nav__item> <a href=#hawksetfrozen class=md-nav__link> Hawk.setFrozen </a> </li> <li class=md-nav__item> <a href=#hawkremoverepository class=md-nav__link> Hawk.removeRepository </a> </li> <li class=md-nav__item> <a href=#hawkupdaterepositorycredentials class=md-nav__link> Hawk.updateRepositoryCredentials </a> </li> <li class=md-nav__item> <a href=#hawklistrepositories class=md-nav__link> Hawk.listRepositories </a> </li> <li class=md-nav__item> <a href=#hawklistrepositorytypes class=md-nav__link> Hawk.listRepositoryTypes </a> </li> <li class=md-nav__item> <a href=#hawklistfiles class=md-nav__link> Hawk.listFiles </a> </li> <li class=md-nav__item> <a href=#hawkconfigurepolling class=md-nav__link> Hawk.configurePolling </a> </li> <li class=md-nav__item> <a href=#hawkaddderivedattribute class=md-nav__link> Hawk.addDerivedAttribute </a> </li> <li class=md-nav__item> <a href=#hawkremovederivedattribute class=md-nav__link> Hawk.removeDerivedAttribute </a> </li> <li class=md-nav__item> <a href=#hawklistderivedattributes class=md-nav__link> Hawk.listDerivedAttributes </a> </li> <li class=md-nav__item> <a href=#hawkaddindexedattribute class=md-nav__link> Hawk.addIndexedAttribute </a> </li> <li class=md-nav__item> <a href=#hawkremoveindexedattribute class=md-nav__link> Hawk.removeIndexedAttribute </a> </li> <li class=md-nav__item> <a href=#hawklistindexedattributes class=md-nav__link> Hawk.listIndexedAttributes </a> </li> <li class=md-nav__item> <a href=#hawkgetmodel class=md-nav__link> Hawk.getModel </a> </li> <li class=md-nav__item> <a href=#hawkgetrootelements class=md-nav__link> Hawk.getRootElements </a> </li> <li class=md-nav__item> <a href=#hawkwatchstatechanges class=md-nav__link> Hawk.watchStateChanges </a> </li> <li class=md-nav__item> <a href=#hawkwatchmodelchanges class=md-nav__link> Hawk.watchModelChanges </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#ifcexport class=md-nav__link> IFCExport </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#ifcexportexportasstep class=md-nav__link> IFCExport.exportAsSTEP </a> </li> <li class=md-nav__item> <a href=#ifcexportgetjobs class=md-nav__link> IFCExport.getJobs </a> </li> <li class=md-nav__item> <a href=#ifcexportgetjobstatus class=md-nav__link> IFCExport.getJobStatus </a> </li> <li class=md-nav__item> <a href=#ifcexportkilljob class=md-nav__link> IFCExport.killJob </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#users class=md-nav__link> Users </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#userscreateuser class=md-nav__link> Users.createUser </a> </li> <li class=md-nav__item> <a href=#usersupdateprofile class=md-nav__link> Users.updateProfile </a> </li> <li class=md-nav__item> <a href=#usersupdatepassword class=md-nav__link> Users.updatePassword </a> </li> <li class=md-nav__item> <a href=#usersdeleteuser class=md-nav__link> Users.deleteUser </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#entities class=md-nav__link> Entities </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attributeslot class=md-nav__link> AttributeSlot </a> </li> <li class=md-nav__item> <a href=#commititem class=md-nav__link> CommitItem </a> </li> <li class=md-nav__item> <a href=#containerslot class=md-nav__link> ContainerSlot </a> </li> <li class=md-nav__item> <a href=#credentials class=md-nav__link> Credentials </a> </li> <li class=md-nav__item> <a href=#derivedattributespec class=md-nav__link> DerivedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#effectivemetamodel class=md-nav__link> EffectiveMetamodel </a> </li> <li class=md-nav__item> <a href=#effectivemetamodelmap class=md-nav__link> EffectiveMetamodelMap </a> </li> <li class=md-nav__item> <a href=#file class=md-nav__link> File </a> </li> <li class=md-nav__item> <a href=#hawkattributeremovalevent class=md-nav__link> HawkAttributeRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkattributeupdateevent class=md-nav__link> HawkAttributeUpdateEvent </a> </li> <li class=md-nav__item> <a href=#hawkchangeevent class=md-nav__link> HawkChangeEvent </a> </li> <li class=md-nav__item> <a href=#hawkfileadditionevent class=md-nav__link> HawkFileAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkfileremovalevent class=md-nav__link> HawkFileRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkinstance class=md-nav__link> HawkInstance </a> </li> <li class=md-nav__item> <a href=#hawkmodelelementadditionevent class=md-nav__link> HawkModelElementAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkmodelelementremovalevent class=md-nav__link> HawkModelElementRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkqueryoptions class=md-nav__link> HawkQueryOptions </a> </li> <li class=md-nav__item> <a href=#hawkreferenceadditionevent class=md-nav__link> HawkReferenceAdditionEvent </a> </li> <li class=md-nav__item> <a href=#hawkreferenceremovalevent class=md-nav__link> HawkReferenceRemovalEvent </a> </li> <li class=md-nav__item> <a href=#hawkstateevent class=md-nav__link> HawkStateEvent </a> </li> <li class=md-nav__item> <a href=#hawksynchronizationendevent class=md-nav__link> HawkSynchronizationEndEvent </a> </li> <li class=md-nav__item> <a href=#hawksynchronizationstartevent class=md-nav__link> HawkSynchronizationStartEvent </a> </li> <li class=md-nav__item> <a href=#ifcexportjob class=md-nav__link> IFCExportJob </a> </li> <li class=md-nav__item> <a href=#ifcexportoptions class=md-nav__link> IFCExportOptions </a> </li> <li class=md-nav__item> <a href=#indexedattributespec class=md-nav__link> IndexedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidmodelspec class=md-nav__link> InvalidModelSpec </a> </li> <li class=md-nav__item> <a href=#invalidtransformation class=md-nav__link> InvalidTransformation </a> </li> <li class=md-nav__item> <a href=#mixedreference class=md-nav__link> MixedReference </a> </li> <li class=md-nav__item> <a href=#modelelement class=md-nav__link> ModelElement </a> </li> <li class=md-nav__item> <a href=#modelelementtype class=md-nav__link> ModelElementType </a> </li> <li class=md-nav__item> <a href=#modelspec class=md-nav__link> ModelSpec </a> </li> <li class=md-nav__item> <a href=#queryresult class=md-nav__link> QueryResult </a> </li> <li class=md-nav__item> <a href=#queryresultmap class=md-nav__link> QueryResultMap </a> </li> <li class=md-nav__item> <a href=#referenceslot class=md-nav__link> ReferenceSlot </a> </li> <li class=md-nav__item> <a href=#repository class=md-nav__link> Repository </a> </li> <li class=md-nav__item> <a href=#slot class=md-nav__link> Slot </a> </li> <li class=md-nav__item> <a href=#slotmetadata class=md-nav__link> SlotMetadata </a> </li> <li class=md-nav__item> <a href=#slotvalue class=md-nav__link> SlotValue </a> </li> <li class=md-nav__item> <a href=#subscription class=md-nav__link> Subscription </a> </li> <li class=md-nav__item> <a href=#userprofile class=md-nav__link> UserProfile </a> </li> <li class=md-nav__item> <a href=#value class=md-nav__link> Value </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#enumerations class=md-nav__link> Enumerations </a> <nav class=md-nav> <ul class=md-nav__list> <li class=md-nav__item> <a href=#commititemchangetype class=md-nav__link> CommitItemChangeType </a> </li> <li class=md-nav__item> <a href=#hawkstate class=md-nav__link> HawkState </a> </li> <li class=md-nav__item> <a href=#ifcexportstatus class=md-nav__link> IFCExportStatus </a> </li> <li class=md-nav__item> <a href=#subscriptiondurability class=md-nav__link> SubscriptionDurability </a> </li> <li class=md-nav__item> <a href=#failedquery class=md-nav__link> FailedQuery </a> </li> <li class=md-nav__item> <a href=#hawkinstancenotfound class=md-nav__link> HawkInstanceNotFound </a> </li> <li class=md-nav__item> <a href=#hawkinstancenotrunning class=md-nav__link> HawkInstanceNotRunning </a> </li> <li class=md-nav__item> <a href=#invalidderivedattributespec class=md-nav__link> InvalidDerivedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidindexedattributespec class=md-nav__link> InvalidIndexedAttributeSpec </a> </li> <li class=md-nav__item> <a href=#invalidmetamodel class=md-nav__link> InvalidMetamodel </a> </li> <li class=md-nav__item> <a href=#invalidpollingconfiguration class=md-nav__link> InvalidPollingConfiguration </a> </li> <li class=md-nav__item> <a href=#invalidquery class=md-nav__link> InvalidQuery </a> </li> <li class=md-nav__item> <a href=#unknownquerylanguage class=md-nav__link> UnknownQueryLanguage </a> </li> <li class=md-nav__item> <a href=#unknownrepositorytype class=md-nav__link> UnknownRepositoryType </a> </li> <li class=md-nav__item> <a href=#userexists class=md-nav__link> UserExists </a> </li> <li class=md-nav__item> <a href=#usernotfound class=md-nav__link> UserNotFound </a> </li> <li class=md-nav__item> <a href=#vcsauthenticationfailed class=md-nav__link> VCSAuthenticationFailed </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content> <article class="md-content__inner md-typeset"> <h1>Thrift API</h1> <h2 id=services>Services<a class=headerlink href=#services title="Permanent link">&para;</a></h2> <h3 id=hawk>Hawk<a class=headerlink href=#hawk title="Permanent link">&para;</a></h3> <p>The following service operations expose the capabilities of the Hawk heterogeneous model indexing framework.</p> <h4 id=hawkcreateinstance>Hawk.createInstance<a class=headerlink href=#hawkcreateinstance title="Permanent link">&para;</a></h4> <p>Creates a new Hawk instance (stopped).</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The unique name of the new Hawk instance.</td> </tr> <tr> <td>backend</td> <td>string</td> <td>The name of the backend to be used, as returned by listBackends().</td> </tr> <tr> <td>minimumDelayMillis</td> <td>i32</td> <td>Minimum delay between periodic synchronization in milliseconds.</td> </tr> <tr> <td>maximumDelayMillis</td> <td>i32</td> <td>Maximum delay between periodic synchronization in milliseconds (0 to disable periodic synchronization).</td> </tr> <tr> <td>enabledPlugins (optional)</td> <td>list<string></td> <td>List of plugins to be enabled: if not set, all plugins are enabled.</td> </tr> </tbody> </table> <h4 id=hawklistbackends>Hawk.listBackends<a class=headerlink href=#hawklistbackends title="Permanent link">&para;</a></h4> <p>Lists the names of the available storage backends.</p> <p>Returns <code>list&lt;string&gt;</code>. Does not take any parameters. </p> <h4 id=hawklistplugins>Hawk.listPlugins<a class=headerlink href=#hawklistplugins title="Permanent link">&para;</a></h4> <p>Lists all the Hawk plugins that can be enabled or disabled: metamodel parsers, model parsers and graph change listeners.</p> <p>Returns <code>list&lt;string&gt;</code>. Does not take any parameters. </p> <h4 id=hawklistinstances>Hawk.listInstances<a class=headerlink href=#hawklistinstances title="Permanent link">&para;</a></h4> <p>Lists the details of all Hawk instances.</p> <p>Returns <code>list&lt;HawkInstance&gt;</code>. Does not take any parameters. </p> <h4 id=hawkremoveinstance>Hawk.removeInstance<a class=headerlink href=#hawkremoveinstance title="Permanent link">&para;</a></h4> <p>Removes an existing Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance to remove.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> </tbody> </table> <h4 id=hawkstartinstance>Hawk.startInstance<a class=headerlink href=#hawkstartinstance title="Permanent link">&para;</a></h4> <p>Starts a stopped Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance to start.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> </tbody> </table> <h4 id=hawkstopinstance>Hawk.stopInstance<a class=headerlink href=#hawkstopinstance title="Permanent link">&para;</a></h4> <p>Stops a running Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance to stop.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawksyncinstance>Hawk.syncInstance<a class=headerlink href=#hawksyncinstance title="Permanent link">&para;</a></h4> <p>Forces an immediate synchronization on a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance to stop.</td> </tr> <tr> <td>blockUntilDone (optional)</td> <td>bool</td> <td>If true, blocks the call until the synchronisation completes. False by default.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkregistermetamodels>Hawk.registerMetamodels<a class=headerlink href=#hawkregistermetamodels title="Permanent link">&para;</a></h4> <p>Registers a set of file-based metamodels with a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>metamodel</td> <td>list<file></td> <td>The metamodels to register. More than one metamodel file can be provided in one request, to accomodate fragmented metamodels.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>InvalidMetamodel</td> <td>The provided metamodel is not valid (e.g. unparsable or inconsistent).</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkunregistermetamodels>Hawk.unregisterMetamodels<a class=headerlink href=#hawkunregistermetamodels title="Permanent link">&para;</a></h4> <p>Unregisters a metamodel from a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>metamodel</td> <td>list<string></td> <td>The URIs of the metamodels.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistmetamodels>Hawk.listMetamodels<a class=headerlink href=#hawklistmetamodels title="Permanent link">&para;</a></h4> <p>Lists the URIs of the registered metamodels of a Hawk instance.</p> <p>Returns <code>list&lt;string&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistquerylanguages>Hawk.listQueryLanguages<a class=headerlink href=#hawklistquerylanguages title="Permanent link">&para;</a></h4> <p>Lists the supported query languages and their status.</p> <p>Returns <code>list&lt;string&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <h4 id=hawkquery>Hawk.query<a class=headerlink href=#hawkquery title="Permanent link">&para;</a></h4> <p>Runs a query on a Hawk instance and returns a sequence of scalar values and/or model elements.</p> <p>Returns <code>QueryResult</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>query</td> <td>string</td> <td>The query to be executed.</td> </tr> <tr> <td>language</td> <td>string</td> <td>The name of the query language used (e.g. EOL, OCL).</td> </tr> <tr> <td>options</td> <td>HawkQueryOptions</td> <td>Options for the query.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> <tr> <td>UnknownQueryLanguage</td> <td>The specified query language is not supported by the operation.</td> </tr> <tr> <td>InvalidQuery</td> <td>The specified query is not valid.</td> </tr> <tr> <td>FailedQuery</td> <td>The specified query failed to complete its execution.</td> </tr> </tbody> </table> <h4 id=hawkresolveproxies>Hawk.resolveProxies<a class=headerlink href=#hawkresolveproxies title="Permanent link">&para;</a></h4> <p>Returns populated model elements for the provided proxies.</p> <p>Returns <code>list&lt;ModelElement&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>ids</td> <td>list<string></td> <td>Proxy model element IDs to be resolved.</td> </tr> <tr> <td>options</td> <td>HawkQueryOptions</td> <td>Options for the query.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkaddrepository>Hawk.addRepository<a class=headerlink href=#hawkaddrepository title="Permanent link">&para;</a></h4> <p>Asks a Hawk instance to start monitoring a repository.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>repo</td> <td>Repository</td> <td>The repository to monitor.</td> </tr> <tr> <td>credentials (optional)</td> <td>Credentials</td> <td>A valid set of credentials that has read-access to the repository.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> <tr> <td>UnknownRepositoryType</td> <td>The specified repository type is not supported by the operation.</td> </tr> <tr> <td>VCSAuthenticationFailed</td> <td>The client failed to prove its identity in the VCS.</td> </tr> </tbody> </table> <h4 id=hawkisfrozen>Hawk.isFrozen<a class=headerlink href=#hawkisfrozen title="Permanent link">&para;</a></h4> <p>Returns true if a repository is frozen, false otherwise.</p> <p>Returns <code>bool</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI of the repository to query.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawksetfrozen>Hawk.setFrozen<a class=headerlink href=#hawksetfrozen title="Permanent link">&para;</a></h4> <p>Changes the 'frozen' state of a repository.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI of the repository to be changed.</td> </tr> <tr> <td>isFrozen</td> <td>bool</td> <td>Whether the repository should be frozen (true) or not (false).</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkremoverepository>Hawk.removeRepository<a class=headerlink href=#hawkremoverepository title="Permanent link">&para;</a></h4> <p>Asks a Hawk instance to stop monitoring a repository and remove its elements from the graph.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI of the repository to stop monitoring.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkupdaterepositorycredentials>Hawk.updateRepositoryCredentials<a class=headerlink href=#hawkupdaterepositorycredentials title="Permanent link">&para;</a></h4> <p>Changes the credentials used to monitor a repository.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI of the repository to update.</td> </tr> <tr> <td>cred</td> <td>Credentials</td> <td>The new credentials to be used.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistrepositories>Hawk.listRepositories<a class=headerlink href=#hawklistrepositories title="Permanent link">&para;</a></h4> <p>Lists the repositories monitored by a Hawk instance.</p> <p>Returns <code>list&lt;Repository&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistrepositorytypes>Hawk.listRepositoryTypes<a class=headerlink href=#hawklistrepositorytypes title="Permanent link">&para;</a></h4> <p>Lists the available repository types in this installation.</p> <p>Returns <code>list&lt;string&gt;</code>. Does not take any parameters. </p> <h4 id=hawklistfiles>Hawk.listFiles<a class=headerlink href=#hawklistfiles title="Permanent link">&para;</a></h4> <p>Lists the paths of the files of the indexed repository.</p> <p>Returns <code>list&lt;string&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>repository</td> <td>list<string></td> <td>The URI of the indexed repository.</td> </tr> <tr> <td>filePatterns</td> <td>list<string></td> <td>File name patterns to search for (* lists all files).</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkconfigurepolling>Hawk.configurePolling<a class=headerlink href=#hawkconfigurepolling title="Permanent link">&para;</a></h4> <p>Sets the base polling period and max interval of a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>base</td> <td>i32</td> <td>The base polling period (in seconds).</td> </tr> <tr> <td>max</td> <td>i32</td> <td>The maximum polling interval (in seconds).</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> <tr> <td>InvalidPollingConfiguration</td> <td>The polling configuration is not valid.</td> </tr> </tbody> </table> <h4 id=hawkaddderivedattribute>Hawk.addDerivedAttribute<a class=headerlink href=#hawkaddderivedattribute title="Permanent link">&para;</a></h4> <p>Add a new derived attribute to a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>spec</td> <td>DerivedAttributeSpec</td> <td>The details of the new derived attribute.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> <tr> <td>InvalidDerivedAttributeSpec</td> <td>The derived attribute specification is not valid.</td> </tr> </tbody> </table> <h4 id=hawkremovederivedattribute>Hawk.removeDerivedAttribute<a class=headerlink href=#hawkremovederivedattribute title="Permanent link">&para;</a></h4> <p>Remove a derived attribute from a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>spec</td> <td>DerivedAttributeSpec</td> <td>The details of the derived attribute to be removed. Only the first three fields of the spec need to be populated.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistderivedattributes>Hawk.listDerivedAttributes<a class=headerlink href=#hawklistderivedattributes title="Permanent link">&para;</a></h4> <p>Lists the derived attributes of a Hawk instance. Only the first three fields of the spec are currently populated.</p> <p>Returns <code>list&lt;DerivedAttributeSpec&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkaddindexedattribute>Hawk.addIndexedAttribute<a class=headerlink href=#hawkaddindexedattribute title="Permanent link">&para;</a></h4> <p>Add a new indexed attribute to a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>spec</td> <td>IndexedAttributeSpec</td> <td>The details of the new indexed attribute.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> <tr> <td>InvalidIndexedAttributeSpec</td> <td>The indexed attribute specification is not valid.</td> </tr> </tbody> </table> <h4 id=hawkremoveindexedattribute>Hawk.removeIndexedAttribute<a class=headerlink href=#hawkremoveindexedattribute title="Permanent link">&para;</a></h4> <p>Remove a indexed attribute from a Hawk instance.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>spec</td> <td>IndexedAttributeSpec</td> <td>The details of the indexed attribute to be removed.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawklistindexedattributes>Hawk.listIndexedAttributes<a class=headerlink href=#hawklistindexedattributes title="Permanent link">&para;</a></h4> <p>Lists the indexed attributes of a Hawk instance.</p> <p>Returns <code>list&lt;IndexedAttributeSpec&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkgetmodel>Hawk.getModel<a class=headerlink href=#hawkgetmodel title="Permanent link">&para;</a></h4> <p>Returns the contents of one or more models indexed in a Hawk instance. Cross-model references are also resolved, and contained objects are always sent.</p> <p>Returns <code>list&lt;ModelElement&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>options</td> <td>HawkQueryOptions</td> <td>Options to limit the contents to be sent.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkgetrootelements>Hawk.getRootElements<a class=headerlink href=#hawkgetrootelements title="Permanent link">&para;</a></h4> <p>Returns the root objects of one or more models indexed in a Hawk instance. Node IDs are always sent, and contained objects are never sent.</p> <p>Returns <code>list&lt;ModelElement&gt;</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>options</td> <td>HawkQueryOptions</td> <td>Options to limit the contents to be sent.</td> </tr> </tbody> </table> <h4 id=hawkwatchstatechanges>Hawk.watchStateChanges<a class=headerlink href=#hawkwatchstatechanges title="Permanent link">&para;</a></h4> <p>Returns subscription details to a queue of HawkStateEvents with notifications about changes in the indexer's state.</p> <p>Returns <code>Subscription</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h4 id=hawkwatchmodelchanges>Hawk.watchModelChanges<a class=headerlink href=#hawkwatchmodelchanges title="Permanent link">&para;</a></h4> <p>Returns subscription details to a queue of HawkChangeEvents with notifications about changes to a set of indexed models.</p> <p>Returns <code>Subscription</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the Hawk instance.</td> </tr> <tr> <td>repositoryUri</td> <td>string</td> <td>The URI of the repository in which the model is contained.</td> </tr> <tr> <td>filePath</td> <td>list<string></td> <td>The pattern(s) for the model file(s) in the repository.</td> </tr> <tr> <td>clientID</td> <td>string</td> <td>Unique client ID (used as suffix for the queue name).</td> </tr> <tr> <td>durableEvents</td> <td>SubscriptionDurability</td> <td>Durability of the subscription.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>HawkInstanceNotFound</td> <td>No Hawk instance exists with that name.</td> </tr> <tr> <td>HawkInstanceNotRunning</td> <td>The selected Hawk instance is not running.</td> </tr> </tbody> </table> <h3 id=ifcexport>IFCExport<a class=headerlink href=#ifcexport title="Permanent link">&para;</a></h3> <p>IFC export facility for getting IFC models from the Hawk server.</p> <h4 id=ifcexportexportasstep>IFCExport.exportAsSTEP<a class=headerlink href=#ifcexportexportasstep title="Permanent link">&para;</a></h4> <p>Export part of a Hawk index in IFC STEP format.</p> <p>Returns <code>IFCExportJob</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>hawkInstance</td> <td>string</td> <td></td> </tr> <tr> <td>options</td> <td>IFCExportOptions</td> <td></td> </tr> </tbody> </table> <h4 id=ifcexportgetjobs>IFCExport.getJobs<a class=headerlink href=#ifcexportgetjobs title="Permanent link">&para;</a></h4> <p>List all the previously scheduled IFC export jobs.</p> <p>Returns <code>list&lt;IFCExportJob&gt;</code>. Does not take any parameters. </p> <h4 id=ifcexportgetjobstatus>IFCExport.getJobStatus<a class=headerlink href=#ifcexportgetjobstatus title="Permanent link">&para;</a></h4> <p>Retrieve the current status of the job with the specified ID.</p> <p>Returns <code>IFCExportJob</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>jobID</td> <td>string</td> <td></td> </tr> </tbody> </table> <h4 id=ifcexportkilljob>IFCExport.killJob<a class=headerlink href=#ifcexportkilljob title="Permanent link">&para;</a></h4> <p>Cancel the job with the specified ID.</p> <p>Returns <code>bool</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>jobID</td> <td>string</td> <td></td> </tr> </tbody> </table> <h3 id=users>Users<a class=headerlink href=#users title="Permanent link">&para;</a></h3> <p>The majority of service operations provided by the server require user authentication (indicated in the top-left cell of each operation table) to prevent unaccountable use. As such, the platform needs to provide basic user management service operations for creating, updating and deleting user accounts. When handling passwords, only SSL should be used, as otherwise they could be intercepted.</p> <h4 id=userscreateuser>Users.createUser<a class=headerlink href=#userscreateuser title="Permanent link">&para;</a></h4> <p>Creates a new platform user.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>username</td> <td>string</td> <td>A unique identifier for the user.</td> </tr> <tr> <td>password</td> <td>string</td> <td>The desired password.</td> </tr> <tr> <td>profile</td> <td>UserProfile</td> <td>The profile of the user.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>UserExists</td> <td>The specified username already exists.</td> </tr> </tbody> </table> <h4 id=usersupdateprofile>Users.updateProfile<a class=headerlink href=#usersupdateprofile title="Permanent link">&para;</a></h4> <p>Updates the profile of a platform user.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>username</td> <td>string</td> <td>The name of the user to update the profile of.</td> </tr> <tr> <td>profile</td> <td>UserProfile</td> <td>The updated profile of the user.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>UserNotFound</td> <td>The specified username does not exist.</td> </tr> </tbody> </table> <h4 id=usersupdatepassword>Users.updatePassword<a class=headerlink href=#usersupdatepassword title="Permanent link">&para;</a></h4> <p>Updates the password of a platform user.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>username</td> <td>string</td> <td>The name of the user to update the profile of.</td> </tr> <tr> <td>newPassword</td> <td>string</td> <td>New password to be set.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>UserNotFound</td> <td>The specified username does not exist.</td> </tr> </tbody> </table> <h4 id=usersdeleteuser>Users.deleteUser<a class=headerlink href=#usersdeleteuser title="Permanent link">&para;</a></h4> <p>Deletes a platform user.</p> <p>Returns <code>void</code>. Takes these parameters:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>username</td> <td>string</td> <td>The name of the user to delete.</td> </tr> </tbody> </table> <p>May throw these exceptions:</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>UserNotFound</td> <td>The specified username does not exist.</td> </tr> </tbody> </table> <h2 id=entities>Entities<a class=headerlink href=#entities title="Permanent link">&para;</a></h2> <h3 id=attributeslot>AttributeSlot<a class=headerlink href=#attributeslot title="Permanent link">&para;</a></h3> <p>Represents a slot that can store the value(s) of an attribute of a model element.</p> <p>Inherits from: Slot.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name (inherited)</td> <td>string</td> <td>The name of the model element property the value of which is stored in this slot.</td> </tr> <tr> <td>value (optional)</td> <td>SlotValue</td> <td>Value of the slot (if set).</td> </tr> </tbody> </table> <p>Used in: ModelElement.</p> <h3 id=commititem>CommitItem<a class=headerlink href=#commititem title="Permanent link">&para;</a></h3> <p>Simplified entry within a commit of a repository.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>path</td> <td>string</td> <td>Path within the repository, using / as separator.</td> </tr> <tr> <td>repoURL</td> <td>string</td> <td>URL of the repository.</td> </tr> <tr> <td>revision</td> <td>string</td> <td>Unique identifier of the revision of the repository.</td> </tr> <tr> <td>type</td> <td>CommitItemChangeType</td> <td>Type of change within the commit.</td> </tr> </tbody> </table> <p>Used in: HawkModelElementAdditionEvent, HawkModelElementRemovalEvent, HawkAttributeUpdateEvent, HawkAttributeRemovalEvent, HawkReferenceAdditionEvent, HawkReferenceRemovalEvent, HawkFileAdditionEvent, HawkFileRemovalEvent.</p> <h3 id=containerslot>ContainerSlot<a class=headerlink href=#containerslot title="Permanent link">&para;</a></h3> <p>Represents a slot that can store other model elements within a model element.</p> <p>Inherits from: Slot.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>elements</td> <td>list<modelelement></td> <td>Contained elements for this slot.</td> </tr> <tr> <td>name (inherited)</td> <td>string</td> <td>The name of the model element property the value of which is stored in this slot.</td> </tr> </tbody> </table> <p>Used in: ModelElement.</p> <h3 id=credentials>Credentials<a class=headerlink href=#credentials title="Permanent link">&para;</a></h3> <p>Credentials of the client in the target VCS.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>password</td> <td>string</td> <td>Password for logging into the VCS.</td> </tr> <tr> <td>username</td> <td>string</td> <td>Username for logging into the VCS.</td> </tr> </tbody> </table> <p>Used in: Hawk.addRepository, Hawk.updateRepositoryCredentials.</p> <h3 id=derivedattributespec>DerivedAttributeSpec<a class=headerlink href=#derivedattributespec title="Permanent link">&para;</a></h3> <p>Used to configure Hawk's derived attributes (discussed in D5.3).</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attributeName</td> <td>string</td> <td>The name of the derived attribute.</td> </tr> <tr> <td>attributeType (optional)</td> <td>string</td> <td>The (primitive) type of the derived attribute.</td> </tr> <tr> <td>derivationLanguage (optional)</td> <td>string</td> <td>The language used to express the derivation logic.</td> </tr> <tr> <td>derivationLogic (optional)</td> <td>string</td> <td>An executable expression of the derivation logic in the language above.</td> </tr> <tr> <td>isMany (optional)</td> <td>bool</td> <td>The multiplicity of the derived attribute.</td> </tr> <tr> <td>isOrdered (optional)</td> <td>bool</td> <td>A flag specifying whether the order of the values of the derived attribute is significant (only makes sense when isMany=true).</td> </tr> <tr> <td>isUnique (optional)</td> <td>bool</td> <td>A flag specifying whether the the values of the derived attribute are unique (only makes sense when isMany=true).</td> </tr> <tr> <td>metamodelUri</td> <td>string</td> <td>The URI of the metamodel to which the derived attribute belongs.</td> </tr> <tr> <td>typeName</td> <td>string</td> <td>The name of the type to which the derived attribute belongs.</td> </tr> </tbody> </table> <p>Used in: Hawk.addDerivedAttribute, Hawk.removeDerivedAttribute, Hawk.listDerivedAttributes.</p> <h3 id=effectivemetamodel>EffectiveMetamodel<a class=headerlink href=#effectivemetamodel title="Permanent link">&para;</a></h3> <p>Representation of a set of rules for either including or excluding certain types and/or slots within a metamodel.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>slots</td> <td>set<string></td> <td>Slots within the type that should be included or excluded: empty means 'all slots'.</td> </tr> <tr> <td>type</td> <td>string</td> <td>Type that should be included or excluded.</td> </tr> </tbody> </table> <p>Used in: EffectiveMetamodelMap.</p> <h3 id=effectivemetamodelmap>EffectiveMetamodelMap<a class=headerlink href=#effectivemetamodelmap title="Permanent link">&para;</a></h3> <p>Representation of a set of rules for either including or excluding metamodels, types or slots.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>metamodel</td> <td>map<string,set&lt;string>&gt;</td> <td>Types and slots within the metamodel that should be included or excluded: empty means 'all types and slots'.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>Namespace URI of the metamodel.</td> </tr> </tbody> </table> <p>Used in: HawkQueryOptions, IFCExportOptions.</p> <h3 id=file>File<a class=headerlink href=#file title="Permanent link">&para;</a></h3> <p>A file to be sent through the network.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>contents</td> <td>binary</td> <td>Sequence of bytes with the contents of the file.</td> </tr> <tr> <td>name</td> <td>string</td> <td>Name of the file.</td> </tr> </tbody> </table> <p>Used in: Hawk.registerMetamodels.</p> <h3 id=hawkattributeremovalevent>HawkAttributeRemovalEvent<a class=headerlink href=#hawkattributeremovalevent title="Permanent link">&para;</a></h3> <p>Serialized form of an attribute removal event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attribute</td> <td>string</td> <td>Name of the attribute that was removed.</td> </tr> <tr> <td>id</td> <td>string</td> <td>Identifier of the model element that was changed.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkattributeupdateevent>HawkAttributeUpdateEvent<a class=headerlink href=#hawkattributeupdateevent title="Permanent link">&para;</a></h3> <p>Serialized form of an attribute update event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attribute</td> <td>string</td> <td>Name of the attribute that was changed.</td> </tr> <tr> <td>id</td> <td>string</td> <td>Identifier of the model element that was changed.</td> </tr> <tr> <td>value</td> <td>SlotValue</td> <td>New value for the attribute.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkchangeevent>HawkChangeEvent<a class=headerlink href=#hawkchangeevent title="Permanent link">&para;</a></h3> <p>Serialized form of a change in the indexed models of a Hawk instance.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>fileAddition</td> <td>HawkFileAdditionEvent</td> <td>A file was added.</td> </tr> <tr> <td>fileRemoval</td> <td>HawkFileRemovalEvent</td> <td>A file was removed.</td> </tr> <tr> <td>modelElementAddition</td> <td>HawkModelElementAdditionEvent</td> <td>A model element was added.</td> </tr> <tr> <td>modelElementAttributeRemoval</td> <td>HawkAttributeRemovalEvent</td> <td>An attribute was removed.</td> </tr> <tr> <td>modelElementAttributeUpdate</td> <td>HawkAttributeUpdateEvent</td> <td>An attribute was updated.</td> </tr> <tr> <td>modelElementRemoval</td> <td>HawkModelElementRemovalEvent</td> <td>A model element was removed.</td> </tr> <tr> <td>referenceAddition</td> <td>HawkReferenceAdditionEvent</td> <td>A reference was added.</td> </tr> <tr> <td>referenceRemoval</td> <td>HawkReferenceRemovalEvent</td> <td>A reference was removed.</td> </tr> <tr> <td>syncEnd</td> <td>HawkSynchronizationEndEvent</td> <td>Synchronization ended.</td> </tr> <tr> <td>syncStart</td> <td>HawkSynchronizationStartEvent</td> <td>Synchronization started.</td> </tr> </tbody> </table> <h3 id=hawkfileadditionevent>HawkFileAdditionEvent<a class=headerlink href=#hawkfileadditionevent title="Permanent link">&para;</a></h3> <p>Serialized form of a file addition event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Reference to file that was added, including VCS metadata.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkfileremovalevent>HawkFileRemovalEvent<a class=headerlink href=#hawkfileremovalevent title="Permanent link">&para;</a></h3> <p>A file was removed.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Reference to file that was removed, including VCS metadata.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkinstance>HawkInstance<a class=headerlink href=#hawkinstance title="Permanent link">&para;</a></h3> <p>Status of a Hawk instance.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>message</td> <td>string</td> <td>Last info message from the instance.</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the instance.</td> </tr> <tr> <td>state</td> <td>HawkState</td> <td>Current state of the instance.</td> </tr> </tbody> </table> <p>Used in: Hawk.listInstances.</p> <h3 id=hawkmodelelementadditionevent>HawkModelElementAdditionEvent<a class=headerlink href=#hawkmodelelementadditionevent title="Permanent link">&para;</a></h3> <p>Serialized form of a model element addition event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the model element that was added.</td> </tr> <tr> <td>metamodelURI</td> <td>string</td> <td>Metamodel URI of the type of the model element.</td> </tr> <tr> <td>typeName</td> <td>string</td> <td>Name of the type of the model element.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkmodelelementremovalevent>HawkModelElementRemovalEvent<a class=headerlink href=#hawkmodelelementremovalevent title="Permanent link">&para;</a></h3> <p>Serialized form of a model element removal event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>string</td> <td>Identifier of the model element that was removed.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkqueryoptions>HawkQueryOptions<a class=headerlink href=#hawkqueryoptions title="Permanent link">&para;</a></h3> <p>Options for a Hawk query.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>defaultNamespaces (optional)</td> <td>string</td> <td>The default namespaces to be used to resolve ambiguous unqualified types.</td> </tr> <tr> <td>effectiveMetamodelExcludes (optional)</td> <td>map<string,map&lt;string,set&lt;string>&gt;&gt;</td> <td>If set and not empty, the mentioned metamodels, types and features will not be fetched. The string '*' can be used to refer to all types within a metamodel or all fields within a type.</td> </tr> <tr> <td>effectiveMetamodelIncludes (optional)</td> <td>map<string,map&lt;string,set&lt;string>&gt;&gt;</td> <td>If set and not empty, only the specified metamodels, types and features will be fetched. Otherwise, everything that is not excluded will be fetched. The string '*' can be used to refer to all types within a metamodel or all fields within a type.</td> </tr> <tr> <td>filePatterns (optional)</td> <td>list<string></td> <td>The file patterns for the query (e.g. *.uml).</td> </tr> <tr> <td>includeAttributes (optional)</td> <td>bool</td> <td>Whether to include attributes (true) or not (false) in model element results.</td> </tr> <tr> <td>includeContained (optional)</td> <td>bool</td> <td>Whether to include all the child elements of the model element results (true) or not (false).</td> </tr> <tr> <td>includeDerived (optional)</td> <td>bool</td> <td>Whether to include derived attributes (true) or not (false) in model element results.</td> </tr> <tr> <td>includeNodeIDs (optional)</td> <td>bool</td> <td>Whether to include node IDs (true) or not (false) in model element results.</td> </tr> <tr> <td>includeReferences (optional)</td> <td>bool</td> <td>Whether to include references (true) or not (false) in model element results.</td> </tr> <tr> <td>repositoryPattern (optional)</td> <td>string</td> <td>The repository for the query (or * for all repositories).</td> </tr> </tbody> </table> <p>Used in: Hawk.query, Hawk.resolveProxies, Hawk.getModel, Hawk.getRootElements.</p> <h3 id=hawkreferenceadditionevent>HawkReferenceAdditionEvent<a class=headerlink href=#hawkreferenceadditionevent title="Permanent link">&para;</a></h3> <p>Serialized form of a reference addition event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>refName</td> <td>string</td> <td>Name of the reference that was added.</td> </tr> <tr> <td>sourceId</td> <td>string</td> <td>Identifier of the source model element.</td> </tr> <tr> <td>targetId</td> <td>string</td> <td>Identifier of the target model element.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkreferenceremovalevent>HawkReferenceRemovalEvent<a class=headerlink href=#hawkreferenceremovalevent title="Permanent link">&para;</a></h3> <p>Serialized form of a reference removal event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>refName</td> <td>string</td> <td>Name of the reference that was removed.</td> </tr> <tr> <td>sourceId</td> <td>string</td> <td>Identifier of the source model element.</td> </tr> <tr> <td>targetId</td> <td>string</td> <td>Identifier of the target model element.</td> </tr> <tr> <td>vcsItem</td> <td>CommitItem</td> <td>Entry within the commit that produced the changes.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawkstateevent>HawkStateEvent<a class=headerlink href=#hawkstateevent title="Permanent link">&para;</a></h3> <p>Serialized form of a change in the state of a Hawk instance.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>message</td> <td>string</td> <td>Short message about the current status of the server.</td> </tr> <tr> <td>state</td> <td>HawkState</td> <td>State of the Hawk instance.</td> </tr> <tr> <td>timestamp</td> <td>i64</td> <td>Timestamp for this state change.</td> </tr> </tbody> </table> <h3 id=hawksynchronizationendevent>HawkSynchronizationEndEvent<a class=headerlink href=#hawksynchronizationendevent title="Permanent link">&para;</a></h3> <p>Serialized form of a sync end event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>timestampNanos</td> <td>i64</td> <td>Local timestamp, measured in nanoseconds. Only meant to be used to compute synchronization cost.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=hawksynchronizationstartevent>HawkSynchronizationStartEvent<a class=headerlink href=#hawksynchronizationstartevent title="Permanent link">&para;</a></h3> <p>Serialized form of a sync start event.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>timestampNanos</td> <td>i64</td> <td>Local timestamp, measured in nanoseconds. Only meant to be used to compute synchronization cost.</td> </tr> </tbody> </table> <p>Used in: HawkChangeEvent.</p> <h3 id=ifcexportjob>IFCExportJob<a class=headerlink href=#ifcexportjob title="Permanent link">&para;</a></h3> <p>Information about a server-side IFC export job.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>jobID</td> <td>string</td> <td></td> </tr> <tr> <td>message</td> <td>string</td> <td></td> </tr> <tr> <td>status</td> <td>IFCExportStatus</td> <td></td> </tr> </tbody> </table> <p>Used in: IFCExport.exportAsSTEP, IFCExport.getJobs, IFCExport.getJobStatus.</p> <h3 id=ifcexportoptions>IFCExportOptions<a class=headerlink href=#ifcexportoptions title="Permanent link">&para;</a></h3> <p>Options for a server-side IFC export.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>excludeRules (optional)</td> <td>map<string,map&lt;string,set&lt;string>&gt;&gt;</td> <td>If set and not empty, the mentioned metamodels, types and features will not be fetched. The string '*' can be used to refer to all types within a metamodel or all fields within a type.</td> </tr> <tr> <td>filePatterns (optional)</td> <td>list<string></td> <td>The file patterns for the query (e.g. *.uml).</td> </tr> <tr> <td>includeRules (optional)</td> <td>map<string,map&lt;string,set&lt;string>&gt;&gt;</td> <td>If set and not empty, only the specified metamodels, types and features will be fetched. Otherwise, everything that is not excluded will be fetched. The string '*' can be used to refer to all types within a metamodel or all fields within a type.</td> </tr> <tr> <td>repositoryPattern (optional)</td> <td>string</td> <td>The repository for the query (or * for all repositories).</td> </tr> </tbody> </table> <p>Used in: IFCExport.exportAsSTEP.</p> <h3 id=indexedattributespec>IndexedAttributeSpec<a class=headerlink href=#indexedattributespec title="Permanent link">&para;</a></h3> <p>Used to configure Hawk's indexed attributes (discussed in D5.3).</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attributeName</td> <td>string</td> <td>The name of the indexed attribute.</td> </tr> <tr> <td>metamodelUri</td> <td>string</td> <td>The URI of the metamodel to which the indexed attribute belongs.</td> </tr> <tr> <td>typeName</td> <td>string</td> <td>The name of the type to which the indexed attribute belongs.</td> </tr> </tbody> </table> <p>Used in: Hawk.addIndexedAttribute, Hawk.removeIndexedAttribute, Hawk.listIndexedAttributes.</p> <h3 id=invalidmodelspec>InvalidModelSpec<a class=headerlink href=#invalidmodelspec title="Permanent link">&para;</a></h3> <p>The model specification is not valid: the model or the metamodels are inaccessible or invalid.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the spec not being valid.</td> </tr> <tr> <td>spec</td> <td>ModelSpec</td> <td>A copy of the invalid model specification.</td> </tr> </tbody> </table> <h3 id=invalidtransformation>InvalidTransformation<a class=headerlink href=#invalidtransformation title="Permanent link">&para;</a></h3> <p>The transformation is not valid: it is unparsable or inconsistent.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>location</td> <td>string</td> <td>Location of the problem, if applicable. Usually a combination of line and column numbers.</td> </tr> <tr> <td>reason</td> <td>string</td> <td>Reason for the transformation not being valid.</td> </tr> </tbody> </table> <h3 id=mixedreference>MixedReference<a class=headerlink href=#mixedreference title="Permanent link">&para;</a></h3> <p>Represents a reference to a model element: it can be an identifier or a position. Only used when the same ReferenceSlot has both identifier-based and position-based references. This may be the case if we are retrieving a subset of the model which has references between its elements and with elements outside the subset at the same time.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>id</td> <td>string</td> <td>Identifier-based reference to a model element.</td> </tr> <tr> <td>position</td> <td>i32</td> <td>Position-based reference to a model element.</td> </tr> </tbody> </table> <p>Used in: ReferenceSlot.</p> <h3 id=modelelement>ModelElement<a class=headerlink href=#modelelement title="Permanent link">&para;</a></h3> <p>Represents a model element.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attributes (optional)</td> <td>list<attributeslot></td> <td>Slots holding the values of the model element's attributes, if any have been set.</td> </tr> <tr> <td>containers (optional)</td> <td>list<containerslot></td> <td>Slots holding contained model elements, if any have been set.</td> </tr> <tr> <td>file (optional)</td> <td>string</td> <td>Name of the file to which the element belongs (not set if equal to that of the previous model element).</td> </tr> <tr> <td>id (optional)</td> <td>string</td> <td>Unique ID of the model element (not set if using position-based references).</td> </tr> <tr> <td>metamodelUri (optional)</td> <td>string</td> <td>URI of the metamodel to which the type of the element belongs (not set if equal to that of the previous model element).</td> </tr> <tr> <td>references (optional)</td> <td>list<referenceslot></td> <td>Slots holding the values of the model element's references, if any have been set.</td> </tr> <tr> <td>repositoryURL (optional)</td> <td>string</td> <td>URI of the repository to which the element belongs (not set if equal to that of the previous model element).</td> </tr> <tr> <td>typeName (optional)</td> <td>string</td> <td>Name of the type that the model element is an instance of (not set if equal to that of the previous model element).</td> </tr> </tbody> </table> <p>Used in: Hawk.resolveProxies, Hawk.getModel, Hawk.getRootElements, ContainerSlot, QueryResult.</p> <h3 id=modelelementtype>ModelElementType<a class=headerlink href=#modelelementtype title="Permanent link">&para;</a></h3> <p>Represents a type of model element.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>attributes (optional)</td> <td>list<slotmetadata></td> <td>Metadata for the attribute slots.</td> </tr> <tr> <td>id</td> <td>string</td> <td>Unique ID of the model element type.</td> </tr> <tr> <td>metamodelUri</td> <td>string</td> <td>URI of the metamodel to which the type belongs.</td> </tr> <tr> <td>references (optional)</td> <td>list<slotmetadata></td> <td>Metadata for the reference slots.</td> </tr> <tr> <td>typeName</td> <td>string</td> <td>Name of the type.</td> </tr> </tbody> </table> <p>Used in: QueryResult.</p> <h3 id=modelspec>ModelSpec<a class=headerlink href=#modelspec title="Permanent link">&para;</a></h3> <p>Captures information about source/target models of ATL transformations.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>metamodelUris</td> <td>list<string></td> <td>The URIs of the metamodels to which elements of the model conform.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI from which the model will be loaded or to which it will be persisted.</td> </tr> </tbody> </table> <p>Used in: InvalidModelSpec.</p> <h3 id=queryresult>QueryResult<a class=headerlink href=#queryresult title="Permanent link">&para;</a></h3> <p>Union type for a scalar value, a reference to a model element, a heterogeneous list or a string/value map. Query results may return all types of results, so we need to stay flexible.</p> <p>Inherits from: Value.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>vBoolean (inherited)</td> <td>bool</td> <td>Boolean (true/false) value.</td> </tr> <tr> <td>vByte (inherited)</td> <td>byte</td> <td>8-bit signed integer value.</td> </tr> <tr> <td>vDouble (inherited)</td> <td>double</td> <td>64-bit floating point value.</td> </tr> <tr> <td>vInteger (inherited)</td> <td>i32</td> <td>32-bit signed integer value.</td> </tr> <tr> <td>vList</td> <td>list<queryresult></td> <td>Nested list of query results.</td> </tr> <tr> <td>vLong (inherited)</td> <td>i64</td> <td>64-bit signed integer value.</td> </tr> <tr> <td>vMap</td> <td>map<string,queryresult></td> <td>Map between query results.</td> </tr> <tr> <td>vModelElement</td> <td>ModelElement</td> <td>Encoded model element.</td> </tr> <tr> <td>vModelElementType</td> <td>ModelElementType</td> <td>Encoded model element type.</td> </tr> <tr> <td>vShort (inherited)</td> <td>i16</td> <td>16-bit signed integer value.</td> </tr> <tr> <td>vString (inherited)</td> <td>string</td> <td>Sequence of UTF8 characters.</td> </tr> </tbody> </table> <p>Used in: Hawk.query, QueryResult, QueryResultMap.</p> <h3 id=queryresultmap>QueryResultMap<a class=headerlink href=#queryresultmap title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td></td> </tr> <tr> <td>value</td> <td>QueryResult</td> <td></td> </tr> </tbody> </table> <p>Used in: QueryResult.</p> <h3 id=referenceslot>ReferenceSlot<a class=headerlink href=#referenceslot title="Permanent link">&para;</a></h3> <p>Represents a slot that can store the value(s) of a reference of a model element. References can be expressed as positions within a result tree (using pre-order traversal) or IDs. id, ids, position, positions and mixed are all mutually exclusive. At least one position or one ID must be given.</p> <p>Inherits from: Slot.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>id (optional)</td> <td>string</td> <td>Unique identifier of the referenced element (if there is only one ID based reference in this slot).</td> </tr> <tr> <td>ids (optional)</td> <td>list<string></td> <td>Unique identifiers of the referenced elements (if more than one).</td> </tr> <tr> <td>mixed (optional)</td> <td>list<mixedreference></td> <td>Mix of identifier- and position-bsaed references (if there is at least one position and one ID).</td> </tr> <tr> <td>name (inherited)</td> <td>string</td> <td>The name of the model element property the value of which is stored in this slot.</td> </tr> <tr> <td>position (optional)</td> <td>i32</td> <td>Position of the referenced element (if there is only one position-based reference in this slot).</td> </tr> <tr> <td>positions (optional)</td> <td>list<i32></td> <td>Positions of the referenced elements (if more than one).</td> </tr> </tbody> </table> <p>Used in: ModelElement.</p> <h3 id=repository>Repository<a class=headerlink href=#repository title="Permanent link">&para;</a></h3> <p>Entity that represents a model repository.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>isFrozen (optional)</td> <td>bool</td> <td>True if the repository is frozen, false otherwise.</td> </tr> <tr> <td>type</td> <td>string</td> <td>The type of repository.</td> </tr> <tr> <td>uri</td> <td>string</td> <td>The URI to the repository.</td> </tr> </tbody> </table> <p>Used in: Hawk.addRepository, Hawk.listRepositories.</p> <h3 id=slot>Slot<a class=headerlink href=#slot title="Permanent link">&para;</a></h3> <p>Represents a slot that can store the value(s) of a property of a model element.</p> <p>Inherited by: AttributeSlot, ReferenceSlot, ContainerSlot.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>string</td> <td>The name of the model element property the value of which is stored in this slot.</td> </tr> </tbody> </table> <h3 id=slotmetadata>SlotMetadata<a class=headerlink href=#slotmetadata title="Permanent link">&para;</a></h3> <p>Represents the metadata of a slot in a model element type.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>isMany</td> <td>bool</td> <td>True if this slot holds a collection of values instead of a single value.</td> </tr> <tr> <td>isOrdered</td> <td>bool</td> <td>True if the values in this slot are ordered.</td> </tr> <tr> <td>isUnique</td> <td>bool</td> <td>True if the value of this slot must be unique within its containing model.</td> </tr> <tr> <td>name</td> <td>string</td> <td>The name of the model element property that is stored in this slot.</td> </tr> <tr> <td>type</td> <td>string</td> <td>The type of the values in this slot.</td> </tr> </tbody> </table> <p>Used in: ModelElementType.</p> <h3 id=slotvalue>SlotValue<a class=headerlink href=#slotvalue title="Permanent link">&para;</a></h3> <p>Union type for a single scalar value or a homogeneous collection of scalar values.</p> <p>Inherits from: Value.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>vBoolean (inherited)</td> <td>bool</td> <td>Boolean (true/false) value.</td> </tr> <tr> <td>vBooleans</td> <td>list<bool></td> <td>List of true/false values.</td> </tr> <tr> <td>vByte (inherited)</td> <td>byte</td> <td>8-bit signed integer value.</td> </tr> <tr> <td>vBytes</td> <td>binary</td> <td>List of 8-bit signed integers.</td> </tr> <tr> <td>vDouble (inherited)</td> <td>double</td> <td>64-bit floating point value.</td> </tr> <tr> <td>vDoubles</td> <td>list<double></td> <td>List of 64-bit floating point values.</td> </tr> <tr> <td>vInteger (inherited)</td> <td>i32</td> <td>32-bit signed integer value.</td> </tr> <tr> <td>vIntegers</td> <td>list<i32></td> <td>List of 32-bit signed integers.</td> </tr> <tr> <td>vLong (inherited)</td> <td>i64</td> <td>64-bit signed integer value.</td> </tr> <tr> <td>vLongs</td> <td>list<i64></td> <td>List of 64-bit signed integers.</td> </tr> <tr> <td>vShort (inherited)</td> <td>i16</td> <td>16-bit signed integer value.</td> </tr> <tr> <td>vShorts</td> <td>list<i16></td> <td>List of 16-bit signed integers.</td> </tr> <tr> <td>vString (inherited)</td> <td>string</td> <td>Sequence of UTF8 characters.</td> </tr> <tr> <td>vStrings</td> <td>list<string></td> <td>List of sequences of UTF8 characters.</td> </tr> </tbody> </table> <p>Used in: HawkAttributeUpdateEvent, AttributeSlot.</p> <h3 id=subscription>Subscription<a class=headerlink href=#subscription title="Permanent link">&para;</a></h3> <p>Details about a subscription to a topic queue.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>host</td> <td>string</td> <td>Host name of the message queue server.</td> </tr> <tr> <td>port</td> <td>i32</td> <td>Port in which the message queue server is listening.</td> </tr> <tr> <td>queueAddress</td> <td>string</td> <td>Address of the topic queue.</td> </tr> <tr> <td>queueName</td> <td>string</td> <td>Name of the topic queue.</td> </tr> <tr> <td>sslRequired</td> <td>bool</td> <td>Whether SSL is required or not.</td> </tr> </tbody> </table> <p>Used in: Hawk.watchStateChanges, Hawk.watchModelChanges.</p> <h3 id=userprofile>UserProfile<a class=headerlink href=#userprofile title="Permanent link">&para;</a></h3> <p>Minimal details about registered users.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>bool</td> <td>Whether the user has admin rights (i.e. so that they can create new users, change the status of admin users etc).</td> </tr> <tr> <td>realName</td> <td>string</td> <td>The real name of the user.</td> </tr> </tbody> </table> <p>Used in: Users.createUser, Users.updateProfile.</p> <h3 id=value>Value<a class=headerlink href=#value title="Permanent link">&para;</a></h3> <p>Union type for a single scalar value.</p> <p>Inherited by: QueryResult, SlotValue.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>vBoolean</td> <td>bool</td> <td>Boolean (true/false) value.</td> </tr> <tr> <td>vByte</td> <td>byte</td> <td>8-bit signed integer value.</td> </tr> <tr> <td>vDouble</td> <td>double</td> <td>64-bit floating point value.</td> </tr> <tr> <td>vInteger</td> <td>i32</td> <td>32-bit signed integer value.</td> </tr> <tr> <td>vLong</td> <td>i64</td> <td>64-bit signed integer value.</td> </tr> <tr> <td>vShort</td> <td>i16</td> <td>16-bit signed integer value.</td> </tr> <tr> <td>vString</td> <td>string</td> <td>Sequence of UTF8 characters.</td> </tr> </tbody> </table> <h2 id=enumerations>Enumerations<a class=headerlink href=#enumerations title="Permanent link">&para;</a></h2> <h3 id=commititemchangetype>CommitItemChangeType<a class=headerlink href=#commititemchangetype title="Permanent link">&para;</a></h3> <p>Type of change within a commit.</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>ADDED</td> <td>File was added.</td> </tr> <tr> <td>DELETED</td> <td>File was removed.</td> </tr> <tr> <td>REPLACED</td> <td>File was removed.</td> </tr> <tr> <td>UNKNOWN</td> <td>Unknown type of change.</td> </tr> <tr> <td>UPDATED</td> <td>File was updated.</td> </tr> </tbody> </table> <h3 id=hawkstate>HawkState<a class=headerlink href=#hawkstate title="Permanent link">&para;</a></h3> <p>One of the states that a Hawk instance can be in.</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>RUNNING</td> <td>The instance is running and monitoring the indexed locations.</td> </tr> <tr> <td>STOPPED</td> <td>The instance is stopped and is not monitoring any indexed locations.</td> </tr> <tr> <td>UPDATING</td> <td>The instance is updating its contents from the indexed locations.</td> </tr> </tbody> </table> <h3 id=ifcexportstatus>IFCExportStatus<a class=headerlink href=#ifcexportstatus title="Permanent link">&para;</a></h3> <p>Status of a server-side IFC export job.</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>CANCELLED</td> <td>The job has been cancelled.</td> </tr> <tr> <td>DONE</td> <td>The job is completed.</td> </tr> <tr> <td>FAILED</td> <td>The job has failed.</td> </tr> <tr> <td>RUNNING</td> <td>The job is currently running.</td> </tr> <tr> <td>SCHEDULED</td> <td>The job has been scheduled but has not started yet.</td> </tr> </tbody> </table> <h3 id=subscriptiondurability>SubscriptionDurability<a class=headerlink href=#subscriptiondurability title="Permanent link">&para;</a></h3> <p>Durability of a subscription.</p> <table> <thead> <tr> <th>Name</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>DEFAULT</td> <td>Subscription survives client disconnections but not server restarts.</td> </tr> <tr> <td>DURABLE</td> <td>Subscription survives client disconnections and server restarts.</td> </tr> <tr> <td>TEMPORARY</td> <td>Subscription removed after disconnecting.</td> </tr> <tr> <td>## Exceptions</td> <td></td> </tr> </tbody> </table> <h3 id=failedquery>FailedQuery<a class=headerlink href=#failedquery title="Permanent link">&para;</a></h3> <p>The specified query failed to complete its execution.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the query failing to complete its execution.</td> </tr> </tbody> </table> <p>Used in: Hawk.query.</p> <h3 id=hawkinstancenotfound>HawkInstanceNotFound<a class=headerlink href=#hawkinstancenotfound title="Permanent link">&para;</a></h3> <p>No Hawk instance exists with that name.</p> <p>No fields for this entity.</p> <p>Used in: Hawk.removeInstance, Hawk.startInstance, Hawk.stopInstance, Hawk.syncInstance, Hawk.registerMetamodels, Hawk.unregisterMetamodels, Hawk.listMetamodels, Hawk.query, Hawk.resolveProxies, Hawk.addRepository, Hawk.isFrozen, Hawk.setFrozen, Hawk.removeRepository, Hawk.updateRepositoryCredentials, Hawk.listRepositories, Hawk.listFiles, Hawk.configurePolling, Hawk.addDerivedAttribute, Hawk.removeDerivedAttribute, Hawk.listDerivedAttributes, Hawk.addIndexedAttribute, Hawk.removeIndexedAttribute, Hawk.listIndexedAttributes, Hawk.getModel, Hawk.watchStateChanges, Hawk.watchModelChanges.</p> <h3 id=hawkinstancenotrunning>HawkInstanceNotRunning<a class=headerlink href=#hawkinstancenotrunning title="Permanent link">&para;</a></h3> <p>The selected Hawk instance is not running.</p> <p>No fields for this entity.</p> <p>Used in: Hawk.stopInstance, Hawk.syncInstance, Hawk.registerMetamodels, Hawk.unregisterMetamodels, Hawk.listMetamodels, Hawk.query, Hawk.resolveProxies, Hawk.addRepository, Hawk.isFrozen, Hawk.setFrozen, Hawk.removeRepository, Hawk.updateRepositoryCredentials, Hawk.listRepositories, Hawk.listFiles, Hawk.configurePolling, Hawk.addDerivedAttribute, Hawk.removeDerivedAttribute, Hawk.listDerivedAttributes, Hawk.addIndexedAttribute, Hawk.removeIndexedAttribute, Hawk.listIndexedAttributes, Hawk.getModel, Hawk.watchStateChanges, Hawk.watchModelChanges.</p> <h3 id=invalidderivedattributespec>InvalidDerivedAttributeSpec<a class=headerlink href=#invalidderivedattributespec title="Permanent link">&para;</a></h3> <p>The derived attribute specification is not valid.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the spec not being valid.</td> </tr> </tbody> </table> <p>Used in: Hawk.addDerivedAttribute.</p> <h3 id=invalidindexedattributespec>InvalidIndexedAttributeSpec<a class=headerlink href=#invalidindexedattributespec title="Permanent link">&para;</a></h3> <p>The indexed attribute specification is not valid.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the spec not being valid.</td> </tr> </tbody> </table> <p>Used in: Hawk.addIndexedAttribute.</p> <h3 id=invalidmetamodel>InvalidMetamodel<a class=headerlink href=#invalidmetamodel title="Permanent link">&para;</a></h3> <p>The provided metamodel is not valid (e.g. unparsable or inconsistent).</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the metamodel not being valid.</td> </tr> </tbody> </table> <p>Used in: Hawk.registerMetamodels.</p> <h3 id=invalidpollingconfiguration>InvalidPollingConfiguration<a class=headerlink href=#invalidpollingconfiguration title="Permanent link">&para;</a></h3> <p>The polling configuration is not valid.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the spec not being valid.</td> </tr> </tbody> </table> <p>Used in: Hawk.configurePolling.</p> <h3 id=invalidquery>InvalidQuery<a class=headerlink href=#invalidquery title="Permanent link">&para;</a></h3> <p>The specified query is not valid.</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Documentation</th> </tr> </thead> <tbody> <tr> <td>reason</td> <td>string</td> <td>Reason for the query not being valid.</td> </tr> </tbody> </table> <p>Used in: Hawk.query.</p> <h3 id=unknownquerylanguage>UnknownQueryLanguage<a class=headerlink href=#unknownquerylanguage title="Permanent link">&para;</a></h3> <p>The specified query language is not supported by the operation.</p> <p>No fields for this entity.</p> <p>Used in: Hawk.query.</p> <h3 id=unknownrepositorytype>UnknownRepositoryType<a class=headerlink href=#unknownrepositorytype title="Permanent link">&para;</a></h3> <p>The specified repository type is not supported by the operation.</p> <p>No fields for this entity.</p> <p>Used in: Hawk.addRepository.</p> <h3 id=userexists>UserExists<a class=headerlink href=#userexists title="Permanent link">&para;</a></h3> <p>The specified username already exists.</p> <p>No fields for this entity.</p> <p>Used in: Users.createUser.</p> <h3 id=usernotfound>UserNotFound<a class=headerlink href=#usernotfound title="Permanent link">&para;</a></h3> <p>The specified username does not exist.</p> <p>No fields for this entity.</p> <p>Used in: Users.updateProfile, Users.updatePassword, Users.deleteUser.</p> <h3 id=vcsauthenticationfailed>VCSAuthenticationFailed<a class=headerlink href=#vcsauthenticationfailed title="Permanent link">&para;</a></h3> <p>The client failed to prove its identity in the VCS.</p> <p>No fields for this entity.</p> <p>Used in: Hawk.addRepository.</p> <hr> <p>This file was automatically generated by Ecore2Thrift.</p> <p>https://github.com/bluezio/ecore2thrift</p> </article> </div> </div> </main> <footer class=md-footer> <div class=md-footer-nav> <nav class="md-footer-nav__inner md-grid"> <a href=../architecture/ title=Architecture class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel=prev> <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> </div> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class=md-flex__ellipsis> <span class=md-footer-nav__direction> Previous </span> Architecture </span> </div> </a> <a href=../api-security/ title="Thrift API security" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel=next> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <span class=md-flex__ellipsis> <span class=md-footer-nav__direction> Next </span> Thrift API security </span> </div> <div class="md-flex__cell md-flex__cell--shrink"> <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> </div> </a> </nav> </div> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-footer-copyright> <div class=md-footer-copyright__highlight> Copyright © Eclipse Foundation, Inc. All Rights Reserved. </div> powered by <a href=https://www.mkdocs.org>MkDocs</a> and <a href=https://squidfunk.github.io/mkdocs-material/ > Material for MkDocs</a> </div> <div class="md-footer-copyright hawk-eclipse-links"> <ul> <li><a href=https://www.eclipse.org/legal/privacy.php>Privacy Policy</a></li> <li><a href=https://www.eclipse.org/legal/termsofuse.php>Terms of Use</a></li> <li><a href=https://www.eclipse.org/legal/copyright.php>Copyright Agent</a></li> </ul> </div> </div> </div> </footer> </div> <script src=../../assets/javascripts/application.c648116f.js></script> <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> </body> </html>