public class JobParams extends Internal
c = omero.scripts.client(name="my algorithm", version="0.0.1")Alternatively, a JobParams instance can be passed into the constructor:
params = omero.grid.JobParams() params.authors = \["Andy", "Kathy"] params.version = "0.0.1" params.description = """ Clever way to count to 5 """ c = omero.scripts.client(params)A single JobParam instance is parsed from a script and stored by the server. Later invocations re-use this instance until the script changes.
Modifier and Type | Field and Description |
---|---|
static java.lang.String[] |
__ids |
java.lang.String[] |
authors
Information about the authors who took part in creating this script.
|
int[][] |
authorsInstitutions
For authors\[i], authorInstitutions\[i] should be
and array of indexes j such that author i is a member
of authorsInstitutions\[i]\[j].
|
java.lang.String |
contact
Single, human-readable string for how to contact the script author.
|
java.lang.String |
description
A general description of a script, including documentation on how
it should be used, what data it will access, and other metrics
like how long it takes to execute, etc.
|
java.util.Map<java.lang.String,Param> |
inputs
Definitive list of the inputs which MAY or MUST be provided
to the script, based on the "optional" flag.
|
java.lang.String[] |
institutions
Information about the institutions which took part in creating this script.
|
java.lang.String |
name
Descriptive name for this script.
|
java.util.List<java.lang.String> |
namespaces
Defines machine readable interpretations for this
JobParams . |
java.util.Map<java.lang.String,Param> |
outputs
Definitive list of the outputs which MAY or MUST be provided
to the script, based on the "optional" flag.
|
static long |
serialVersionUID |
java.lang.String |
stderrFormat
omero.model.Format.value of the stderr stream produced by
the script. |
java.lang.String |
stdoutFormat
omero.model.Format.value of the stdout stream produced
by the script. |
java.lang.String |
version
Author-given version number for this script.
|
Constructor and Description |
---|
JobParams() |
JobParams(java.lang.String name,
java.lang.String version,
java.lang.String description,
java.lang.String contact,
java.lang.String[] authors,
java.lang.String[] institutions,
int[][] authorsInstitutions,
java.util.Map<java.lang.String,Param> inputs,
java.util.Map<java.lang.String,Param> outputs,
java.lang.String stdoutFormat,
java.lang.String stderrFormat,
java.util.List<java.lang.String> namespaces) |
Modifier and Type | Method and Description |
---|---|
protected void |
__readImpl(IceInternal.BasicStream __is) |
protected void |
__writeImpl(IceInternal.BasicStream __os) |
JobParams |
clone() |
static Ice.ObjectFactory |
ice_factory() |
java.lang.String |
ice_id() |
java.lang.String |
ice_id(Ice.Current __current) |
java.lang.String[] |
ice_ids() |
java.lang.String[] |
ice_ids(Ice.Current __current) |
boolean |
ice_isA(java.lang.String s) |
boolean |
ice_isA(java.lang.String s,
Ice.Current __current) |
static java.lang.String |
ice_staticId() |
public static final java.lang.String[] __ids
public java.lang.String name
public java.lang.String version
public java.lang.String description
public java.lang.String contact
public java.lang.String[] authors
public java.lang.String[] institutions
public int[][] authorsInstitutions
public java.util.Map<java.lang.String,Param> inputs
public java.util.Map<java.lang.String,Param> outputs
public java.lang.String stdoutFormat
omero.model.Format.value
of the stdout stream produced
by the script. If this value is not otherwise set (i.e. is
None), the default of "text/plain" will be set. This is
typically a good idea if the script uses "print" or the logging
module.
If you would like to disable stdout upload, set the value to ""
(the empty string).
"text/html" or "application/octet-stream" might also be values of interest.public java.lang.String stderrFormat
omero.model.Format.value
of the stderr stream produced by
the script. If this value is not otherwise set (i.e. is None),
the default of "text/plain" will be set. This is typically a
good idea if the script uses "print" or the logging module.
If you would like to disable stderr upload, set the value to ""
(the empty string).
"text/html" or "application/octet-stream" might also be values of interest.public java.util.List<java.lang.String> namespaces
JobParams
.
Where the description field should provide information for users, the assigned namespaces can define how clients may interpret the script, including which categories or algorithm types the script belongs to.
public static final long serialVersionUID
public JobParams()
public JobParams(java.lang.String name, java.lang.String version, java.lang.String description, java.lang.String contact, java.lang.String[] authors, java.lang.String[] institutions, int[][] authorsInstitutions, java.util.Map<java.lang.String,Param> inputs, java.util.Map<java.lang.String,Param> outputs, java.lang.String stdoutFormat, java.lang.String stderrFormat, java.util.List<java.lang.String> namespaces)
public static Ice.ObjectFactory ice_factory()
public boolean ice_isA(java.lang.String s)
public boolean ice_isA(java.lang.String s, Ice.Current __current)
public java.lang.String[] ice_ids()
public java.lang.String[] ice_ids(Ice.Current __current)
public java.lang.String ice_id()
public java.lang.String ice_id(Ice.Current __current)
public static java.lang.String ice_staticId()
protected void __writeImpl(IceInternal.BasicStream __os)
__writeImpl
in class Internal
protected void __readImpl(IceInternal.BasicStream __is)
__readImpl
in class Internal