References¶
Authentication¶
| Helper class for user authentication. |
API¶
| Automatically authenticate the user either through a webbrowser or auth-link printed to the terminal. |
| Attempts to bring up a webbrowser for the user to authenticate. |
Jobs¶
|
API¶
| Request to stop job - sent by launcher |
| Request to pause job - sent by launcher |
| Start running the job |
| Request results of Top from docker - sent by launcher |
| Request results of logs from docker - sent by launcher |
| Get a filtered list of all jobs run under your Galileo account. |
| Download your job results when job is completed |
| Updates an existing job |
| Request to kill a job |
| Download and extract your job results when job is completed |
Objects¶
| Job Object |
| An enumeration. |
| An enumeration. |
| An enumeration. |
| A class representing a Job Update Request |
| A class representing a Job Status |
| |
|
Events¶
| Callback will execute upon a job launcher updated event |
| |
| Callback will execute upon a station job updated event |
| Callback will execute upon a station job updated event |
Lz¶
|
API¶
| Get a specific Landing Zone’s info by its id |
| Get a filtered list of landing zones Landing Zones and their stats. |
| Update the info about a Landing Zone |
Objects¶
| |
| An enumeration. |
| |
| Class representing a request to update a Landing Zone |
Events¶
| Callback will execute upon a landing zone status update event |
| Callback will execute upon a landing zone hardware update event |
| Callback will execute upon a machine hardware update event |
Profiles¶
|
API¶
| Get your Galileo profile |
Get all your station invites | |
| Get all Galileo users and their profiles |
Objects¶
| |
|
Missions¶
|
API¶
| Get list of Missions associated with your account |
| Get a specific Mission’s details by providing its UUID |
| Create a new Mission in your Galileo account. |
| Upload a file or directory to the specified Mission. |
| Run a job on a station |
| Run a job on a landing zone |
| Create a new Mission in your Galileo account and upload input files from the specified directory in the same call. |
| Create mission and run a job |
| Provides the metadata of all files in a Mission context |
| Delete a single file in a Mission |
| Update the settings and metadata associated with a Mission context. |
| Update the arguments to a mission. |
Gets a list of summaries of Mission Framework Types. | |
| Retrieve more detailed information about a Mission Framework Type |
| Gets the settings of a particular Mission Framework Type. |
Objects¶
| |
| |
| |
| |
| |
|
Stations¶
|
API¶
| Get a filtered list of Galileo Stations that are accessible in your account. |
| Create a new station |
| Invite user(s) to a station |
| Accept an invitation to join a station |
| Reject an invitation to join a station |
| Request to join a station |
| Admins and owners can approve members to join a station |
| Admins and owners can reject members that want to join a station |
| Leave a station as a member |
| Remove a member from a station |
| Permanently delete a station |
| Add landing zones to a station |
| Remove landing zones from a station |
| Add host path to volume before running a job Host path is where the landing zone will store the results of a job |
| Remove a host path Host path is where the landing zone will store the results of a job |
| Remove a volume from station |
| Update a station |
| Gets the resource policy for a station |
| Updates an the resource policy attached to the station. |
| Deletes the resource policy associated with the station. |
| Returns the user’s calculated (or effective) resource policy in the station. |
| Updates a user in a station. |
| Gets the resource policy for a station user. |
Updates an the resource policy attached to the station user. | |
Deletes the resource policy associated with the station user. | |
| Updates an existing role |
| Deletes an existing role. |
| Gets the resource policy for a station role. |
Updates an the resource policy attached to the station role. | |
Deletes the resource policy associated with the station role. | |
| Gets the resource policy for a station lz. |
Updates an the resource policy attached to the station lz. | |
Deletes the resource policy associated with the station lz. | |
| Returns the user’s calculated (or effective) resource policy for this particular lz in a station |
Objects¶
Events¶
| Callback will execute upon a creation of a new station |
Callback will execute upon an invite sent Emitted to admin of a station | |
Callback will execute upon a user receiving an invite to a station Emitted to the user that receives the invite | |
Callback will execute upon an invite to a station being accepted Emitted to admin of station | |
Callback will execute upon a member has been added (request has been approved or invitation has been accepted) Emitted to all members of a station | |
Callback will execute upon a user accepting an invite to a station Emitted to user who has accepted the invitation | |
Callback will execute when an invite to a station has been rejected Emitted to admin of station | |
Callback will execute when a request to join the station has been received Emitted to admin of station | |
Callback will execute when a request to join the station has been sent Emitted to user requesting to join the station | |
Callback will execute when a request to join a station has been accepted Emitted to admin of station | |
Callback will execute when a request to join a station has been accepted Emitted to user who sent the request | |
Callback will execute when a request to join a station has been rejected Emitted to admin of station | |
Callback will execute when a request to join a station has been rejected Emitted to user who sent the request | |
Callback will execute when a member has been removed from a station Emitted to admin of station | |
Callback will execute when a machine has been removed from a station Emitted to admin of station | |
Callback will execute when a member has been removed from a station Emitted to members of a station | |
Callback will execute when a lz has been removed from a station Emitted to members of a station | |
Callback will execute when a user has withdrawn from the station Emitted to user that is withdrawing | |
| Callback will execute when a user has been expelled from the station Emitted to user that has been expelled |
Callback will execute when a station has been destroyed Emitted to admin of station | |
Callback will execute when a station has been destroyed Emitted to member of station | |
Callback will execute when a station has been destroyed Emitted to anyone who received an invite to join the station | |
Callback will execute when a station has been destroyed Emitted to anyone who sent a request to join to the station | |
Callback will execute when a lz has been added to the station Emitted to admin of station | |
Callback will execute when a lz has been added to the station Emitted to members of station | |
Callback will execute when a volume has been added to the station Emitted to admin of station | |
Callback will execute when a volume has been added to the station Emitted to members of station | |
Callback will execute when a volume host path has been added Emitted to admin of station | |
Callback will execute when a volume host path has been added Emitted to members of station | |
Callback will execute when a volume host path has been removed Emitted to admin of station | |
Callback will execute when a volume host path has been removed Emitted to members of station | |
Callback will execute when a volume has been removed Emitted to admin of station | |
Callback will execute when a volume has been removed Emitted to members of station |