On this page

Reference documentation

This page contains detailed API reference documentation. It is intended to be an in-depth resource for understanding the implementation details of machinable's interfaces. You may prefer reviewing the more explanatory guide before consulting this reference.

API

Component
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- created_at
- derive
- derived
- dispatch
- dispatch_code
- executions
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_after_dispatch
- on_before_commit
- on_before_configure
- on_before_dispatch
- on_commit
- on_compute_predicate
- on_configure
- on_failure
- on_finish
- on_heartbeat
- on_instantiate
- on_seeding
- on_success
- on_write_meta_data
- project
- push_related
- related
- related_iterator
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Element
- as_default
- as_json
- clone
- collect
- compute_context
- compute_predicate
- connected
- created_at
- from_json
- from_model
- get
- instance
- is_connected
- load_attribute
- make
- matches
- model
- on_after_configure
- on_before_configure
- on_compute_predicate
- on_configure
- on_instantiate
- save_attribute
- serialize
- set_default
- set_model
- singleton
- unserialize
- version
Execution
- add
- all
- ancestor
- as_default
- as_json
- cached
- canonicalize_resources
- clone
- collect
- commit
- component_directory
- compute_context
- compute_predicate
- computed_resources
- connected
- created_at
- deferred
- derive
- derived
- dispatch
- executable
- executables
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- finished_at
- from_directory
- from_json
- from_model
- future
- get
- heartbeat_at
- hidden
- instance
- is_active
- is_committed
- is_connected
- is_finished
- is_incomplete
- is_live
- is_mounted
- is_resumed
- is_staged
- is_started
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- of
- on_add
- on_after_commit
- on_after_configure
- on_after_dispatch
- on_before_commit
- on_before_configure
- on_before_dispatch
- on_commit
- on_compute_default_resources
- on_compute_predicate
- on_configure
- on_instantiate
- on_verify_schedule
- output
- output_filepath
- project
- push_related
- related
- related_iterator
- resumed_at
- retrieve_status
- save_attribute
- save_file
- schedule
- serialize
- set_default
- set_model
- singleton
- stage
- started_at
- stream_output
- to_cli
- to_directory
- unserialize
- update_status
- used_by
- uses
- version
Index
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- config_in_directory
- connected
- create_relation
- created_at
- derive
- derived
- fetch
- find
- find_by_context
- find_by_hash
- find_by_id
- find_many_by_id
- find_related
- from_directory
- from_json
- from_model
- future
- get
- hidden
- import_directory
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- project
- push_related
- related
- related_iterator
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Interface
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- created_at
- derive
- derived
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- project
- push_related
- related
- related_iterator
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Mixin
Project
- add_to_path
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- created_at
- derive
- derived
- element
- exists
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- get_code_version
- get_diff
- get_host_info
- get_root
- get_vendors
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_root
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- name
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- on_parse_cli
- on_resolve_element
- on_resolve_remotes
- on_resolve_vendor
- path
- project
- provider
- push_related
- related
- related_iterator
- resolve_remotes
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Schedule
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- created_at
- derive
- derived
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- project
- push_related
- related
- related_iterator
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Scope
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- created_at
- derive
- derived
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- project
- push_related
- related
- related_iterator
- save_attribute
- save_file
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- used_by
- uses
- version
Storage
- all
- ancestor
- as_default
- as_json
- cached
- clone
- collect
- commit
- compute_context
- compute_predicate
- connected
- contains
- created_at
- derive
- derived
- download
- fetch
- find
- find_by_hash
- find_by_id
- find_many_by_id
- from_directory
- from_json
- from_model
- future
- get
- hidden
- instance
- is_committed
- is_connected
- is_mounted
- is_staged
- launch
- load_attribute
- load_file
- local_directory
- make
- matches
- model
- new
- on_after_commit
- on_after_configure
- on_before_commit
- on_before_configure
- on_commit
- on_compute_predicate
- on_configure
- on_instantiate
- project
- push_related
- related
- related_iterator
- retrieve
- save_attribute
- save_file
- search_for
- serialize
- set_default
- set_model
- singleton
- stage
- to_cli
- to_directory
- unserialize
- update
- upload
- used_by
- uses
- version
mixin
- Mixin
- bind
- mixin
cli
- from_cli
- main
- parse
collection
- Collection
- ComponentCollection
- ElementCollection
- ExecutionCollection
- InterfaceCollection
- collect
- data_get
- reduce
component
- Component
config
- to_dict
element
- ConfigMethod
- Element
- compact
- defaultversion
- equaljson
- equalversion
- extend
- extract
- get_dump
- get_lineage
- instantiate
- normversion
- reset_connections
- transfer_to
- uuid_to_id
errors
- ComponentException
  - add_note
  - with_traceback
- ConfigurationError
  - add_note
  - with_traceback
- DependencyMissing
  - add_note
  - with_traceback
- ExecutionFailed
  - add_note
  - with_traceback
- MachinableError
  - add_note
  - with_traceback
- StorageError
  - add_note
  - with_traceback
execution
- Execution
index
- Index
- db
- interface_row_factory
- load
- migrate
interface
- BelongsTo
  - collect
- BelongsToMany
  - collect
- HasMany
  - collect
- HasOne
  - collect
- Interface
- Relation
  - collect
- belongs_to
- belongs_to_many
- cachable
- has_many
- has_one
project
- Project
- fetch_directory
- fetch_git
- fetch_link
- fetch_vendor
- fetch_vendors
- import_element
query
- Query
schedule
- Schedule
schema
- Component
- Element
- Execution
- Index
- Interface
- Project
- Schedule
- Scope
- Storage
scope
- Scope
storage
- Storage
- fetch
types
utils
- Connectable
  - get
  - is_connected
- Jsonable
  - as_json
  - clone
  - from_json
  - serialize
  - unserialize
- chmodx
- dot_splitter
- empty_uuid
- file_hash
- find_installed_extensions
- find_subclass_in_module
- generate_nickname
- generate_seed
- get_commit
- get_diff
- get_root_commit
- id_from_uuid
- import_from_directory
- is_directory_version
- is_valid_module_path
- is_valid_variable_name
- iskeyword
- joinpath
- load_file
- norm_version_call
- normjson
- object_hash
- random_str
- run_and_stream
- save_file
- serialize
- timestamp_to_directory
- unflatten_dict
- update_dict
- update_uuid_payload