References

Authentication

AuthSdk([client_id, audience])

Helper class for user authentication.

API

initialize([refresh_token_path])

Automatically authenticate the user either through a webbrowser or auth-link printed to the terminal.

device_flow([refresh_token_path])

Attempts to bring up a webbrowser for the user to authenticate.

Jobs

JobsSdk(jobs_service[, connector, events])

API

request_stop_job(job_id)

Request to stop job - sent by launcher

request_pause_job(job_id)

Request to pause job - sent by launcher

request_start_job(job_id)

Start running the job

request_top_from_job(job_id)

Request results of Top from docker - sent by launcher

request_logs_from_job(job_id)

Request results of logs from docker - sent by launcher

list_jobs([job_ids, receiver_ids, user_ids, …])

Get a filtered list of all jobs run under your Galileo account.

download_job_results(job_id, path[, nonce])

Download your job results when job is completed

update_job(job_id[, archived])

Updates an existing job

request_kill_job(job_id)

Request to kill a job

download_and_extract_job_results(job_id, path)

Download and extract your job results when job is completed

Objects

Job(job_id, receiver_id, mission_id, …[, …])

Job Object

EJobStatus(value)

An enumeration.

EJobRunningStatus(value)

An enumeration.

EPaymentStatus(value)

An enumeration.

UpdateJobRequest(job_id, archived)

A class representing a Job Update Request

JobStatus(timestamp, status[, …])

A class representing a Job Status

JobLauncherUpdatedEvent(job)

JobLauncherSubmittedEvent(job)

StationJobUpdatedEvent(job)

StationJobUpdatedEvent(job)

JobTopEvent(job, top)

JobLogEvent(job, log)

Events

on_job_launcher_updated(func)

Callback will execute upon a job launcher updated event

on_job_launcher_submitted(func)

param func

Callable[[JobLauncherSubmittedEvent]

on_station_job_updated(func)

Callback will execute upon a station job updated event

on_station_job_updated(func)

Callback will execute upon a station job updated event

Lz

LzSdk(lz_service[, connector, events])

API

get_lz_by_id(lz_id)

Get a specific Landing Zone’s info by its id

list_lz([lz_ids, user_ids, page, items])

Get a filtered list of landing zones Landing Zones and their stats.

update_lz(lz_id[, name, active])

Update the info about a Landing Zone

Objects

Lz(name, user_id, status, lz_id, gpu_count, …)

ELzStatus(value)

An enumeration.

LzStatusUpdateEvent(lz_id, status)

LzHardwareUpdateEvent(lz)

LzRegisteredEvent(lz)

UpdateLzRequest(lz_id[, name, active])

Class representing a request to update a Landing Zone

Events

on_lz_status_update(func)

Callback will execute upon a landing zone status update event

on_lz_hardware_update(func)

Callback will execute upon a landing zone hardware update event

on_lz_registered(func)

Callback will execute upon a machine hardware update event

Profiles

ProfilesSdk(profiles_service)

API

self()

Get your Galileo profile

list_station_invites()

Get all your station invites

list_users([user_ids, usernames, …])

Get all Galileo users and their profiles

Objects

Profile([user_id, username, lz_ids, …])

ProfileCard(id, user_id, …)

Missions

MissionsSdk(missions_service)

API

list_missions([mission_ids, names, …])

Get list of Missions associated with your account

get_mission_by_id(mission_id)

Get a specific Mission’s details by providing its UUID

create_mission(name[, description, …])

Create a new Mission in your Galileo account.

upload(mission_id, payload[, rename, verbose])

Upload a file or directory to the specified Mission.

run_job_on_station(mission_id, station_id[, …])

Run a job on a station

run_job_on_lz(mission_id, station_id, lz_id)

Run a job on a landing zone

create_and_upload_mission(name, directory[, …])

Create a new Mission in your Galileo account and upload input files from the specified directory in the same call.

create_mission_and_run_job(name, directory, …)

Create mission and run a job

get_mission_files(mission_id)

Provides the metadata of all files in a Mission context

delete_file(mission_id, file_path)

Delete a single file in a Mission

update_mission(mission_id[, name, …])

Update the settings and metadata associated with a Mission context.

update_mission_args(mission_id, arg)

Update the arguments to a mission.

list_mission_types()

Gets a list of summaries of Mission Framework Types.

get_mission_type(mission_type_id)

Retrieve more detailed information about a Mission Framework Type

get_mission_type_settings_info(mission_type_id)

Gets the settings of a particular Mission Framework Type.

Objects

Mission(mission_id, name, description, …)

MissionType(id, name, description, version)

CreateMissionRequest(name, description[, …])

UpdateMissionRequest(mission_id[, name, …])

FileListing(filename, path, …[, nonce])

DirectoryListing(storage_id, path, listings)

Stations

StationsSdk(stations_service[, connector, …])

API

list_stations([station_ids, names, lz_ids, …])

Get a filtered list of Galileo Stations that are accessible in your account.

create_station(name[, description, user_ids])

Create a new station

invite_to_station(station_id, user_ids, role_id)

Invite user(s) to a station

accept_station_invite(station_id)

Accept an invitation to join a station

reject_station_invite(station_id)

Reject an invitation to join a station

request_to_join(station_id)

Request to join a station

approve_request_to_join(station_id, user_ids)

Admins and owners can approve members to join a station

reject_request_to_join(station_id, user_ids)

Admins and owners can reject members that want to join a station

leave_station(station_id)

Leave a station as a member

remove_member_from_station(station_id, user_id)

Remove a member from a station

delete_station(station_id)

Permanently delete a station

add_lz_to_station(station_id, lz_ids)

Add landing zones to a station

remove_lz_from_station(station_id, lz_ids)

Remove landing zones from a station

add_host_path_to_volume(station_id, …)

Add host path to volume before running a job Host path is where the landing zone will store the results of a job

delete_host_path_from_volume(station_id, …)

Remove a host path Host path is where the landing zone will store the results of a job

remove_volume_from_station(station_id, volume_id)

Remove a volume from station

update_station(station_id[, name, …])

Update a station

get_station_resource_policy(station_id)

Gets the resource policy for a station

update_station_resource_policy(station_id[, …])

Updates an the resource policy attached to the station.

delete_station_resource_policy(station_id)

Deletes the resource policy associated with the station.

get_self_station_resource_limits(station_id)

Returns the user’s calculated (or effective) resource policy in the station.

update_station_member(station_id, user_id, …)

Updates a user in a station.

get_station_user_resource_policy(station_id, …)

Gets the resource policy for a station user.

update_station_user_resource_policy(…[, …])

Updates an the resource policy attached to the station user.

delete_station_user_resource_policy(…)

Deletes the resource policy associated with the station user.

update_station_role(station_id, station_role_id)

Updates an existing role

delete_station_role(station_id, role_id)

Deletes an existing role.

get_station_role_resource_policy(station_id, …)

Gets the resource policy for a station role.

update_station_role_resource_policy(…[, …])

Updates an the resource policy attached to the station role.

delete_station_role_resource_policy(…)

Deletes the resource policy associated with the station role.

get_station_lz_resource_policy(station_id, lz_id)

Gets the resource policy for a station lz.

update_station_lz_resource_policy(…[, …])

Updates an the resource policy attached to the station lz.

delete_station_lz_resource_policy(…)

Deletes the resource policy associated with the station lz.

get_station_lz_resource_limits(station_id, lz_id)

Returns the user’s calculated (or effective) resource policy for this particular lz in a station

Objects

Station(station_id, name, description, users)

StationUser(stationuser_id, user_id[, …])

Volume(station_id, name, mount_point, …)

VolumeHostPath(volume_hostpath_id, lz_id, …)

EStationUserRole(value)

An enumeration.

EVolumeAccess(value)

An enumeration.

NewStationEvent(station)

StationAdminInviteSentEvent(station_id, user_ids)

StationUserInviteReceivedEvent(station)

StationAdminInviteAcceptedEvent(station_id, …)

StationMemberMemberEvent(station_id, user_id)

StationUserInviteAcceptedEvent(station_id, …)

StationUserInviteRejectedEvent(station_id, …)

StationAdminRequestReceivedEvent(station_id, …)

StationUserRequestSentEvent(station_id, user_id)

StationAdminRequestAcceptedEvent(station_id, …)

StationUserRequestAcceptedEvent(station_id)

StationAdminRequestRejectedEvent(station_id, …)

StationUserRequestRejectedEvent(station_id)

StationAdminMemberRemovedEvent(station_id, …)

StationAdminLzRemovedEvent(station_id, lz_ids)

StationMemberMemberRemovedEvent(station_id, …)

StationMemberLzRemovedEvent(station_id, lz_ids)

StationUserWithdrawnEvent(station_id, lz_ids)

StationUserExpelledEvent(stationid)

StationAdminDestroyedEvent(station_id)

StationMemberDestroyedEvent(station_id)

StationUserInviteDestroyedEvent(station_id)

StationUserRequestDestroyedEvent(station_id)

StationAdminLzAddedEvent(station_id, mids)

StationMemberLzAddedEvent(station_id, mids)

StationAdminVolumeAddedEvent(station_id, volumes)

StationMemberVolumeAddedEvent(station_id, …)

StationAdminVolumeHostPathAddedEvent(…)

StationMemberVolumeHostPathAddedEvent(…)

StationAdminVolumeHostPathRemovedEvent(…)

StationMemberVolumeHostPathRemovedEvent(…)

StationAdminVolumeRemovedEvent(station_id, …)

StationMemberVolumeRemovedEvent(station_id, …)

Events

on_new_station(func)

Callback will execute upon a creation of a new station

on_station_admin_invite_sent(func)

Callback will execute upon an invite sent Emitted to admin of a station

on_station_user_invite_received(func)

Callback will execute upon a user receiving an invite to a station Emitted to the user that receives the invite

on_station_admin_invite_accepted(func)

Callback will execute upon an invite to a station being accepted Emitted to admin of station

on_station_member_member_added(func)

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

on_station_user_invite_accepted(func)

Callback will execute upon a user accepting an invite to a station Emitted to user who has accepted the invitation

on_station_admin_invite_rejected(func)

Callback will execute when an invite to a station has been rejected Emitted to admin of station

on_station_admin_request_received(func)

Callback will execute when a request to join the station has been received Emitted to admin of station

on_station_user_request_sent(func)

Callback will execute when a request to join the station has been sent Emitted to user requesting to join the station

on_station_admin_request_accepted(func)

Callback will execute when a request to join a station has been accepted Emitted to admin of station

on_station_user_request_accepted(func)

Callback will execute when a request to join a station has been accepted Emitted to user who sent the request

on_station_admin_request_rejected(func)

Callback will execute when a request to join a station has been rejected Emitted to admin of station

on_station_user_request_rejected(func)

Callback will execute when a request to join a station has been rejected Emitted to user who sent the request

on_station_admin_member_removed(func)

Callback will execute when a member has been removed from a station Emitted to admin of station

on_station_admin_lz_removed(func)

Callback will execute when a machine has been removed from a station Emitted to admin of station

on_station_member_member_removed(func)

Callback will execute when a member has been removed from a station Emitted to members of a station

on_station_member_lz_removed(func)

Callback will execute when a lz has been removed from a station Emitted to members of a station

on_station_user_withdrawn(func)

Callback will execute when a user has withdrawn from the station Emitted to user that is withdrawing

on_station_user_expelled(func)

Callback will execute when a user has been expelled from the station Emitted to user that has been expelled

on_station_admin_destroyed(func)

Callback will execute when a station has been destroyed Emitted to admin of station

on_station_member_destroyed(func)

Callback will execute when a station has been destroyed Emitted to member of station

on_station_user_invite_destroyed(func)

Callback will execute when a station has been destroyed Emitted to anyone who received an invite to join the station

on_station_user_request_destroyed(func)

Callback will execute when a station has been destroyed Emitted to anyone who sent a request to join to the station

on_station_admin_lz_added(func)

Callback will execute when a lz has been added to the station Emitted to admin of station

on_station_member_lz_added(func)

Callback will execute when a lz has been added to the station Emitted to members of station

on_station_admin_volume_added(func)

Callback will execute when a volume has been added to the station Emitted to admin of station

on_station_member_volume_added(func)

Callback will execute when a volume has been added to the station Emitted to members of station

on_station_admin_volume_host_path_added(func)

Callback will execute when a volume host path has been added Emitted to admin of station

on_station_member_volume_host_path_added(func)

Callback will execute when a volume host path has been added Emitted to members of station

on_station_admin_volume_host_path_removed(func)

Callback will execute when a volume host path has been removed Emitted to admin of station

on_station_member_volume_host_path_removed(func)

Callback will execute when a volume host path has been removed Emitted to members of station

on_station_admin_volume_removed(func)

Callback will execute when a volume has been removed Emitted to admin of station

on_station_member_volume_removed(func)

Callback will execute when a volume has been removed Emitted to members of station