Package saga :: Package job :: Module _job :: Class job

Class job

 object --+            
          |            
??.instance --+        
              |        
 _engine.object --+    
                  |    
       _engine.task --+
                      |
                     job

Known Subclasses:

self

Nested Classes

[hide private]

Inherited from _engine.task: routine_type, task_state

Inherited from _engine.object: object_type

Instance Methods

[hide private]

__init__(...)
Raises an exception This class cannot be instantiated from Python

attribute_exists(...)
attribute_exists( (job)arg1, (str)arg2) -> bool : tests if the given attribute exists for this instance (plain)

attribute_is_readonly(...)
attribute_is_readonly( (job)arg1, (str)arg2) -> bool : tests if the given attribute is read only (plain)

attribute_is_removable(...)
attribute_is_removable( (job)arg1, (str)arg2) -> bool : tests if the given attribute is removable (plain)

attribute_is_vector(...)
attribute_is_vector( (job)arg1, (str)arg2) -> bool : tests if the given attribute is a vector attribute (plain)

attribute_is_writable(...)
attribute_is_writable( (job)arg1, (str)arg2) -> bool : tests if the given attribute is writable (plain)

checkpoint(...)
checkpoint( (job)arg1) -> None : checkpoint this job (plain)

find_attributes(...)
find_attributes( (job)arg1, (str)arg2) -> object : find attributes matching the given pattern (plain)

get_attribute(...)
get_attribute( (job)arg1, (str)arg2) -> str : returns a (scalar) attribute associated with this object (plain)

get_description(...)
get_description( (job)arg1) -> description : get a copy of the job description this job was created from (plain)

get_job_id(...)
get_job_id( (job)arg1) -> str : get the job id of this job (plain)

get_state(...)
get_state( (job)arg1) -> job_state : get the state of this job (plain)

get_stderr(...)
get_stderr( (job)arg1) -> object : get a file object representing the stderr of the spawned job (plain)

get_stdin(...)
get_stdin( (job)arg1) -> object : get a file object representing the stdin of the spawned job (plain)

get_stdout(...)
get_stdout( (job)arg1) -> object : get a file object representing the stdout of the spawned job (plain)

get_vector_attribute(...)
get_vector_attribute( (job)arg1, (str)arg2) -> object : returns a (vector) attribute associated with this object (plain)

list_attributes(...)
list_attributes( (job)arg1) -> object : lists the keys of all attributes associated with this object (plain)

migrate(...)
migrate( (job)arg1, (description)arg2) -> None : migrate this job (plain)

remove_attribute(...)
remove_attribute( (job)arg1, (str)arg2) -> None : removes an attribute associated with this object (plain)

resume(...)
resume( (job)arg1) -> None : resume this job (plain)

run(...)
run( (job)arg1) -> None : run this job (plain)

set_attribute(...)
set_attribute( (job)arg1, (str)arg2, (str)arg3) -> None : sets a (scalar) attribute associated with this object (plain)

set_vector_attribute(...)
set_vector_attribute( (job)arg1, (str)arg2, (object)arg3) -> None : sets a (vector) attribute associated with this object (plain)

signal(...)
signal( (job)arg1, (int)arg2) -> None : send a signal to this job (plain)

suspend(...)
suspend( (job)arg1) -> None : suspend this job (plain)

Inherited from _engine.task: add_callback, cancel, get_metric, get_object, get_result, list_metrics, remove_callback, rethrow, wait

Inherited from _engine.object: __reduce__, clone, get_id, get_object_type_name, get_session, get_type

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from _engine.task: ASync, Canceled, Done, Failed, New, Running, Sync, Task, Unknown

Inherited from _engine.object: Advert, AdvertDirectory, Buffer, Context, Directory, Endpoint, Exception, File, IOVec, Job, JobDescription, JobSelf, JobService, LogicalDirectory, LogicalFile, Metric, Msg, NSDirectory, NSEntry, Parameter, RPC, Session, Stream, StreamServer, TaskContainer, URL, __instance_size__

Properties

[hide private]

Inherited from _engine.task: object, state

Inherited from _engine.object: id, session, type

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

attribute_exists(...)


attribute_exists( (job)arg1, (str)arg2) -> bool :
    tests if the given attribute exists for this instance (plain)

    C++ signature :
        bool attribute_exists(saga::job::job,std::string)

attribute_exists( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute exists for this instance (task based)

    C++ signature :
        saga::task attribute_exists(saga::job::job,saga::python::routine_type,std::string)

attribute_is_readonly(...)


attribute_is_readonly( (job)arg1, (str)arg2) -> bool :
    tests if the given attribute is read only (plain)

    C++ signature :
        bool attribute_is_readonly(saga::job::job,std::string)

attribute_is_readonly( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is read only (task based)

    C++ signature :
        saga::task attribute_is_readonly(saga::job::job,saga::python::routine_type,std::string)

attribute_is_removable(...)


attribute_is_removable( (job)arg1, (str)arg2) -> bool :
    tests if the given attribute is removable (plain)

    C++ signature :
        bool attribute_is_removable(saga::job::job,std::string)

attribute_is_removable( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is removable (task based)

    C++ signature :
        saga::task attribute_is_removable(saga::job::job,saga::python::routine_type,std::string)

attribute_is_vector(...)


attribute_is_vector( (job)arg1, (str)arg2) -> bool :
    tests if the given attribute is a vector attribute (plain)

    C++ signature :
        bool attribute_is_vector(saga::job::job,std::string)

attribute_is_vector( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is a vector attribute (task based)

    C++ signature :
        saga::task attribute_is_vector(saga::job::job,saga::python::routine_type,std::string)

attribute_is_writable(...)


attribute_is_writable( (job)arg1, (str)arg2) -> bool :
    tests if the given attribute is writable (plain)

    C++ signature :
        bool attribute_is_writable(saga::job::job,std::string)

attribute_is_writable( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    tests if the given attribute is writable (task based)

    C++ signature :
        saga::task attribute_is_writable(saga::job::job,saga::python::routine_type,std::string)

checkpoint(...)


checkpoint( (job)arg1) -> None :
    checkpoint this job (plain)

    C++ signature :
        void checkpoint(saga::job::job)

checkpoint( (job)arg1, (routine_type)arg2) -> task :
    checkpoint this job (task based)

    C++ signature :
        saga::task checkpoint(saga::job::job,saga::python::routine_type)

find_attributes(...)


find_attributes( (job)arg1, (str)arg2) -> object :
    find attributes matching the given pattern (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > find_attributes(saga::job::job,std::string)

find_attributes( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    find attributes matching the given pattern (task based)

    C++ signature :
        saga::task find_attributes(saga::job::job,saga::python::routine_type,std::string)

get_attribute(...)


get_attribute( (job)arg1, (str)arg2) -> str :
    returns a (scalar) attribute associated with this object (plain)

    C++ signature :
        std::string get_attribute(saga::job::job,std::string)

get_attribute( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task get_attribute(saga::job::job,saga::python::routine_type,std::string)

get_description(...)


get_description( (job)arg1) -> description :
    get a copy of the job description this job was created from (plain)

    C++ signature :
        saga::job::description get_description(saga::job::job)

get_description( (job)arg1, (routine_type)arg2) -> task :
    get a copy of the job description this job was created from (task based)

    C++ signature :
        saga::task get_description(saga::job::job,saga::python::routine_type)

get_job_id(...)


get_job_id( (job)arg1) -> str :
    get the job id of this job (plain)

    C++ signature :
        std::string get_job_id(saga::job::job)

get_job_id( (job)arg1, (routine_type)arg2) -> task :
    get the job id of this job (task based)

    C++ signature :
        saga::task get_job_id(saga::job::job,saga::python::routine_type)

get_state(...)


get_state( (job)arg1) -> job_state :
    get the state of this job (plain)

    C++ signature :
        saga::job::state get_state(saga::job::job)

get_state( (job)arg1, (routine_type)arg2) -> task :
    get the state of this job (task based)

    C++ signature :
        saga::task get_state(saga::job::job,saga::python::routine_type)

Overrides: _engine.task.get_state

get_stderr(...)


get_stderr( (job)arg1) -> object :
    get a file object representing the stderr of the spawned job (plain)

    C++ signature :
        boost::python::api::object get_stderr(saga::job::job)

get_stderr( (job)arg1, (routine_type)arg2) -> task :
    get a file object representing the stderr of the spawned job (task based)

    C++ signature :
        saga::task get_stderr(saga::job::job,saga::python::routine_type)

get_stdin(...)


get_stdin( (job)arg1) -> object :
    get a file object representing the stdin of the spawned job (plain)

    C++ signature :
        boost::python::api::object get_stdin(saga::job::job)

get_stdin( (job)arg1, (routine_type)arg2) -> task :
    get a file object representing the stdin of the spawned job (task based)

    C++ signature :
        saga::task get_stdin(saga::job::job,saga::python::routine_type)

get_stdout(...)


get_stdout( (job)arg1) -> object :
    get a file object representing the stdout of the spawned job (plain)

    C++ signature :
        boost::python::api::object get_stdout(saga::job::job)

get_stdout( (job)arg1, (routine_type)arg2) -> task :
    get a file object representing the stdout of the spawned job (task based)

    C++ signature :
        saga::task get_stdout(saga::job::job,saga::python::routine_type)

get_vector_attribute(...)


get_vector_attribute( (job)arg1, (str)arg2) -> object :
    returns a (vector) attribute associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > get_vector_attribute(saga::job::job,std::string)

get_vector_attribute( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    returns a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task get_vector_attribute(saga::job::job,saga::python::routine_type,std::string)

list_attributes(...)


list_attributes( (job)arg1) -> object :
    lists the keys of all attributes associated with this object (plain)

    C++ signature :
        std::vector<std::string, std::allocator<std::string> > list_attributes(saga::job::job)

list_attributes( (job)arg1, (routine_type)arg2) -> task :
    lists the keys of all attributes associated with this object (task based)

    C++ signature :
        saga::task list_attributes(saga::job::job,saga::python::routine_type)

migrate(...)


migrate( (job)arg1, (description)arg2) -> None :
    migrate this job (plain)

    C++ signature :
        void migrate(saga::job::job,saga::job::description)

migrate( (job)arg1, (routine_type)arg2, (description)arg3) -> task :
    migrate this job (task based)

    C++ signature :
        saga::task migrate(saga::job::job,saga::python::routine_type,saga::job::description)

remove_attribute(...)


remove_attribute( (job)arg1, (str)arg2) -> None :
    removes an attribute associated with this object (plain)

    C++ signature :
        void remove_attribute(saga::job::job,std::string)

remove_attribute( (job)arg1, (routine_type)arg2, (str)arg3) -> task :
    removes an attribute associated with this object (task based)

    C++ signature :
        saga::task remove_attribute(saga::job::job,saga::python::routine_type,std::string)

resume(...)


resume( (job)arg1) -> None :
    resume this job (plain)

    C++ signature :
        void resume(saga::job::job)

resume( (job)arg1, (routine_type)arg2) -> task :
    resume this job (task based)

    C++ signature :
        saga::task resume(saga::job::job,saga::python::routine_type)

run(...)


run( (job)arg1) -> None :
    run this job (plain)

    C++ signature :
        void run(saga::job::job)

run( (job)arg1, (routine_type)arg2) -> task :
    run this job (task based)

    C++ signature :
        saga::task run(saga::job::job,saga::python::routine_type)

Overrides: _engine.task.run

set_attribute(...)


set_attribute( (job)arg1, (str)arg2, (str)arg3) -> None :
    sets a (scalar) attribute associated with this object (plain)

    C++ signature :
        void set_attribute(saga::job::job,std::string,std::string)

set_attribute( (job)arg1, (routine_type)arg2, (str)arg3, (str)arg4) -> task :
    sets a (scalar) attribute associated with this object (task based)

    C++ signature :
        saga::task set_attribute(saga::job::job,saga::python::routine_type,std::string,std::string)

set_vector_attribute(...)


set_vector_attribute( (job)arg1, (str)arg2, (object)arg3) -> None :
    sets a (vector) attribute associated with this object (plain)

    C++ signature :
        void set_vector_attribute(saga::job::job,std::string,std::vector<std::string, std::allocator<std::string> >)

set_vector_attribute( (job)arg1, (routine_type)arg2, (str)arg3, (object)arg4) -> task :
    sets a (vector) attribute associated with this object (task based)

    C++ signature :
        saga::task set_vector_attribute(saga::job::job,saga::python::routine_type,std::string,std::vector<std::string, std::allocator<std::string> >)

signal(...)


signal( (job)arg1, (int)arg2) -> None :
    send a signal to this job (plain)

    C++ signature :
        void signal(saga::job::job,int)

signal( (job)arg1, (routine_type)arg2, (int)arg3) -> task :
    send a signal to this job (task based)

    C++ signature :
        saga::task signal(saga::job::job,saga::python::routine_type,int)

suspend(...)


suspend( (job)arg1) -> None :
    suspend this job (plain)

    C++ signature :
        void suspend(saga::job::job)

suspend( (job)arg1, (routine_type)arg2) -> task :
    suspend this job (task based)

    C++ signature :
        saga::task suspend(saga::job::job,saga::python::routine_type)

Class job

__init__(...) (Constructor)

attribute_exists(...)

attribute_is_readonly(...)

attribute_is_removable(...)

attribute_is_vector(...)

attribute_is_writable(...)

checkpoint(...)

find_attributes(...)

get_attribute(...)

get_description(...)

get_job_id(...)

get_state(...)

get_stderr(...)

get_stdin(...)

get_stdout(...)

get_vector_attribute(...)

list_attributes(...)

migrate(...)

remove_attribute(...)

resume(...)

run(...)

set_attribute(...)

set_vector_attribute(...)

signal(...)

suspend(...)

init(...)
(Constructor)