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([jobids, receiverids, oaids, …])

List of your jobs :param jobids: List[str]: Filter by job ids :param receiverids: List[str]: Filter by receiver ids :param oaids: List[str]: Filter by offer acceptance ids :param userids: List[str]: Filter by user ids :param stationids: List[str]: Filter by station ids :param statuses: List[str]: Filter by statuses :param page: int: Filter by page :param items: int: Filter by items :param projectids: List[str]: Filter by projectid :param archived: boolean: Filter by archived :param receiver_archived: boolean: Filter by receiver archived :param partial_names: List[str]: Filter by partial names :param machines: List[str]: Filter by machines id :param ownerids: List[str]: Filter by ownerid :param sort_by: EJobSort :param sort_order: str: “asc” or “desc” :return: List[Job]

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(jobid, receiverid, project_id, …)

Details of a job

EJobStatus(value)

An enumeration.

EJobRunningStatus(value)

An enumeration.

EPaymentStatus(value)

An enumeration.

UpdateJobRequest(job_id, archived)

JobStatus(timestamp, status[, jobstatusid, …])

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 landing zone’s info by its id

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

List all machines

update_lz(lz_id[, name, active])

Update info about landing zone

Objects

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

ELzStatus(value)

An enumeration.

LzStatusUpdateEvent(lz_id, status)

LzHardwareUpdateEvent(lz)

LzRegisteredEvent(lz)

UpdateLzRequest(lz_id[, name, active])

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([userids, usernames, …])

Get all Galileo users and their profiles

Objects

Profile([userid, username, lz_ids, wallets, …])

ProfileWallet(wallet, public_key[, …])

ProfileCard(id, user_id, …)

Missions

MissionsSdk(missions_service)

API

list_missions([ids, names, user_ids, page, …])

Get list of missions

get_mission_by_id(mission_id)

Get a mission’s details by searching its id :param mission_id: str: Mission id :return: Mission

create_mission(name[, description, …])

Create a mission

upload(mission_id, directory)

Upload a directory

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 and upload mission

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

delete_file(mission_id, file_path)

Delete file in mission

update_mission(mission_id[, name, …])

param mission_id

str: Mission type id

update_mission_args(mission_id, arg)

Update the arguments to a mission.

list_mission_types()

Gets a list of summaries of mission types

get_mission_type(mission_type_id)

Get a mission type further info

get_mission_type_settings_info(mission_type_id)

Gets the mission type’s settings info.

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([stationids, names, lz_ids, …])

List of your Galileo stations :param stationids: Optional[List[str]]: Filter based on station ids :param names: Optional[List[str]]: Filter based on names :param lz_ids: Optional[List[str]]: Filter based on landing zone ids :param user_roles: Optional[List[str]]: Filter based on user roles :param volumeids: Optional[List[str]]: Filter based on volumeids :param descriptions: Optional[List[str]]: Filter based on descriptions :param page: Optional[int]: Page # :param items: Optional[int]: Items per page :param active: Optional[str]: Filter for all active stations (“true”,”false”) :param userids: Optional[List[str]]: Filter based on userid :param lz_status: Optional[List[str]] :param lz_count_max: Optional[int] :param lz_count_min: Optional[int] :param updated: Optional[str] :param partial_names: Optional[List[str]] :return: List[Station]

create_station(name[, description, userids])

Create a new station

invite_to_station(station_id, userids)

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, userids)

Admins and owners can approve members to join a station

reject_request_to_join(station_id, userids)

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, userid)

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_volumes_to_station(station_id, name, …)

Add volumes to 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, description])

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, userid, …)

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(stationid, name, description, users)

StationUser(stationuserid, userid[, status, …])

Volume(stationid, name, mount_point, access, …)

VolumeHostPath(volumehostpathid, mid, host_path)

EStationUserRole(value)

An enumeration.

EVolumeAccess(value)

An enumeration.

NewStationEvent(station)

StationAdminInviteSentEvent(stationid, userids)

StationUserInviteReceivedEvent(station)

StationAdminInviteAcceptedEvent(stationid, …)

StationMemberMemberEvent(stationid, userid)

StationUserInviteAcceptedEvent(stationid, userid)

StationUserInviteRejectedEvent(stationid, …)

StationAdminRequestReceivedEvent(stationid, …)

StationUserRequestSentEvent(stationid, userid)

StationAdminRequestAcceptedEvent(stationid, …)

StationUserRequestAcceptedEvent(stationid)

StationAdminRequestRejectedEvent(stationid, …)

StationUserRequestRejectedEvent(stationid)

StationAdminMemberRemovedEvent(stationid, …)

StationAdminLzRemovedEvent(stationid, lz_ids)

StationMemberMemberRemovedEvent(stationid, …)

StationMemberLzRemovedEvent(stationid, lz_ids)

StationUserWithdrawnEvent(stationid, lz_ids)

StationUserExpelledEvent(stationid)

StationAdminDestroyedEvent(stationid)

StationMemberDestroyedEvent(stationid)

StationUserInviteDestroyedEvent(stationid)

StationUserRequestDestroyedEvent(stationid)

StationAdminLzAddedEvent(stationid, mids)

StationMemberLzAddedEvent(stationid, mids)

StationAdminVolumeAddedEvent(stationid, volumes)

StationMemberVolumeAddedEvent(stationid, volumes)

StationAdminVolumeHostPathAddedEvent(…)

StationMemberVolumeHostPathAddedEvent(…)

StationAdminVolumeHostPathRemovedEvent(…)

StationMemberVolumeHostPathRemovedEvent(…)

StationAdminVolumeRemovedEvent(stationid, …)

StationMemberVolumeRemovedEvent(stationid, …)

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