Simplified API that is intended for passing
Bases: omero.cmd.GraphModify
Bases: omero.cmd.GraphModify2
Move model objects into a different experimenter group. The user must be either an administrator, or the owner of the objects and a member of the target group. Members: groupId – The ID of the experimenter group into which to move the model objects.
Bases: omero.cmd.GraphModify2Prx
Bases: omero.cmd.OK
Result of moving model objects into a different experimenter group. Members: includedObjects – The model objects that were moved. deletedObjects – The model objects that were deleted.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.GraphModifyPrx
Bases: omero.cmd.Response
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.GraphModify
Modifies the permissions settings for the given object. Most permission modifications will be quite fast and will specify this as returning a small number of steps in the status object. When lowering a READ setting, however, all existing data will need to be checked and there will be a minimum of one step per table in the database. At the moment, the only supported type is “”/ExperimenterGroup””. Members: permissions – String representation of the permissions which should be set on the object.
Bases: omero.cmd.GraphModify2
Change the permissions on model objects. The user must be an administrator, the owner of the objects, or an owner of the objects’ group. The only permitted target object type is ExperimenterGroup. Members: permissions – The permissions to set on the model objects.
Bases: omero.cmd.GraphModify2Prx
Bases: omero.cmd.OK
Result of changing the permissions on model objects. Members: includedObjects – The model objects with changed permissions. deletedObjects – The model objects that were deleted.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.GraphModifyPrx
Bases: omero.cmd.Response
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.GraphModify
Bases: omero.cmd.GraphModify2
Change the ownership of model objects. The user must be an administrator, or they must be an owner of the objects’ group, with the target user a member of the objects’ group. Members: userId – The ID of the experimenter to which to give the model objects.
Bases: omero.cmd.GraphModify2Prx
Bases: omero.cmd.OK
Result of changing the ownership of model objects. Members: includedObjects – The model objects that were given. deletedObjects – The model objects that were deleted.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.GraphModifyPrx
Bases: omero.cmd.Response
Bases: omero.cmd.ResponsePrx
Bases: Ice.Object
Called when the command has completed in any fashion including cancellation. The Status#flags list will contain information about whether or not the process was cancelled. Arguments: rsp – s – current – The Current object for the invocation.
Notifies clients that the given number of steps from the total is complete. This method will not necessarily be called for every step. Arguments: complete – total – current – The Current object for the invocation.
Bases: IcePy.ObjectPrx
Notifies clients that the given number of steps from the total is complete. This method will not necessarily be called for every step. Arguments: complete – total – _ctx – The request context for the invocation.
Bases: omero.cmd.Request
Argument-less request that will produce a CurrentSessionsResponse if no omero.cmd.ERR occurs.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Return value from omero.cmd.CurrentSessionsRequest consisting of two ordered lists of matching length. The sessions field contains a list of the OMERO omero.model.Session objects that are currently active after all timeouts have been applied. This is the value that would be returned by omero.api.ISession#getSession when joined to that session. Similarly, the contexts field contains the value that would be returned by a call to omero.api.IAdmin#getEventContext. For non-administrators, most values for all sessions other than those belonging to that user will be nulled. Members: sessions – omero.model.Session objects loaded from the database. contexts – omero.sys.EventContext objects stored in memory by the server. data – Other session state which may vary based on usage. This may include “hitCount”, “lastAccess”, and similar metrics.
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.GraphModify
Delete requests will return a omero.cmd.DeleteRsp unless an error has occurred in which case a standard omero.cmd.ERR may be returned.
Bases: omero.cmd.GraphModify2
Delete model objects.
Bases: omero.cmd.GraphModify2Prx
Bases: omero.cmd.OK
Result of deleting model objects. Members: deletedObjects – The model objects that were deleted.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.GraphModifyPrx
Bases: omero.cmd.OK
Mirrors and replaces DeleteReport. There is no “”error”” field because if there was an error than an ERR object will be returned. Members: warning – Extra feedback mechanism. Typically will only be non-empty if the error is empty. This implies that some situation was encountered that the user may need to be informed of (e.g. some annotation wasn’t deleted), but which was non-critical. undeletedFiles – Map from type name (“”Thumbnail””, “”Pixels””, “”OriginalFile””) to a list of ids for any binary files which did not get deleted. Some action may be desired by the user to guarantee that this server-space is eventually steps – Number of steps that this DeleteCommand requires. scheduledDeletes – Number of objects that this DeleteCommand will attempt to delete. actualDeletes – Number of actual deletes which took place.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.Request
Request to determine the disk usage of the given objects and their contents. File-system paths used by multiple objects are de-duplicated in the total count. Specifying a class is equivalent to specifying all its instances as objects. Permissible classes include: ExperimenterGroup, Experimenter, Project, Dataset, Screen, Plate, Well, WellSample, Image, Pixels, Annotation, Job, Fileset, OriginalFile.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Disk usage report: bytes used and non-empty file counts on the repository file-system for specific objects. The counts from the maps may sum to more than the total if different types of object refer to the same file. Common referers include: Annotation for file annotations FilesetEntry for OMERO 5 image files (OMERO.fs) Job for import logs Pixels for pyramids and OMERO 4 images and archived files Thumbnail for the image thumbnails The above map values are broken down by owner-group keys.
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.Request
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.OK
Bases: omero.cmd.OKPrx
Bases: omero.cmd.GraphModify2
Duplicate model objects with some selection of their subgraph. All target model objects must be in the current group context. The extra three data members allow adjustment of the related subgraph. The same type must not be listed in more than one of those data members. Use of a more specific sub-type in a data member always overrides the more general type in another. Members: typesToDuplicate – The types of the model objects to actually duplicate. typesToReference – The types of the model objects that should not be duplicated but that may participate in references involving duplicates. typesToIgnore – The types of the model objects that should not be duplicated and that may not participate in references involving duplicates.
Bases: omero.cmd.GraphModify2Prx
Bases: omero.cmd.OK
Result of duplicating model objects. Members: duplicates – The duplicate model objects created by the request. Note: If dryRun is set to true then this instead lists the model objects that would have been duplicated.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.Response
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.Request
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.OK
Bases: omero.cmd.OKPrx
Bases: omero.cmd.ERR
Returned when specifically a ome.services.graphs.GraphConstraintException is thrown. The contents of that internal exception are passed in this instance. Members: constraints – A container mapping from class names to collections of longs (ids) for each object which prevented the current operation from succeeding.
Bases: omero.cmd.ERRPrx
Bases: omero.cmd.ERR
Returned when specifically a ome.services.graphs.GraphException is thrown. The contents of that internal exception are passed in this instance. Members: message – The message of the GraphException.
Bases: omero.cmd.ERRPrx
Bases: omero.cmd.Request
Bases: omero.cmd.Request
Base class for new requests for operating upon the model object graph. Members: targetObjects – The model objects upon which to operate. Related model objects may also be targeted. childOptions – If the request should operate on specific kinds of children. Only the first applicable option takes effect. dryRun – If this request should skip the actual model object updates. The response is still as if the operation actually occurred, indicating what would have been done to which objects.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.RequestPrx
Bases: Ice.Object
Add a callback for notifications. Arguments: cb – current – The Current object for the invocation.
Attempts to cancel execution of this Request. Returns true if cancellation was successful. Returns false if not, in which case likely this request will run to completion. Arguments: current – The Current object for the invocation.
Closes this handle. If the request is running, then a cancellation will be attempted first. All uses of a handle should be surrounded by a try/finally close block. Arguments: current – The Current object for the invocation.
Returns the request object that was used to initialize this handle. Never null. Arguments: current – The Current object for the invocation.
Returns a response if this handle has finished execution, otherwise returns null. Arguments: current – The Current object for the invocation.
Returns a status object for the current execution. This will likely be the same object that would be returned as a component of the Response value. Never null. Arguments: current – The Current object for the invocation.
Remove callback for notifications. Arguments: cb – current – The Current object for the invocation.
Bases: IcePy.ObjectPrx
Add a callback for notifications. Arguments: cb – _ctx – The request context for the invocation.
Bases: omero.cmd.Request
Graph requests typically allow only specific model object classes to be targeted. This request lists the legal targets for a given request. The request’s fields are ignored, only its class matters. Members: request – A request of the type being queried.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.OK
A list of the legal targets for a graph request. Members: targets – The legal targets for the given request’s type.
Bases: omero.cmd.OKPrx
Bases: omero.cmd.Request
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.OK
Bases: omero.cmd.OKPrx
Bases: omero.cmd.Request
Queries and modifies the various binary artifacts which may be linked to an omero.model.Image. This can be useful, e.g., after converting pre-OMERO-5 archived original files into omero.model.Fileset. The command works in several stages: 1. loads an omero.model.Image by id, failing if none present. 2. renames Pixels file to ‘*_bak’ 3. deletes existing Pyramidfiles if present; This command can be run multiple times with different settings to iteratively test if the migration is working.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Response from a ManageImageBinaries Request. If no action is requested, then the fields of this instance can be examined to see what would be done if requested.
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.Response
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.Request
Requests the file metadata to be loaded for a given image. This should handle both the pre-FS metadata in file annotations as well as loading the metadata directly from the FS files. A OriginalMetadataResponse will be returned under normal conditions, otherwise a ERR will be returned.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Successful response for OriginalMetadataRequest. Contains both the global and the series metadata as maps. Only one of filesetId or filesetAnnotationId will be set. Pre-FS images will have filesetAnnotationId set; otherwise filesetId will be set. Members: filesetId – Set to the id of the omero.model.Fileset that this omero.model.Image contained in if one exists. fileAnnotationId – Set to the id of the omero.model.FilesetAnnotation linked to this omero.model.Image if one exists. globalMetadata – Metadata which applies to the entire omero.model.Fileset seriesMetadata – Metadata specific to the series id of this omero.model.Image. In the omero.model.Fileset that this
omero.model.Image] is contained in, there may be a large
number of other images, but the series metadata applies only to this specific one.
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.Request
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.OK
Bases: omero.cmd.OKPrx
Bases: Ice.Object
Bases: IcePy.ObjectPrx
Bases: omero.cmd.Request
Requests a reset password for the given user. examples: - omero.cmd.ResetPasswordRequest(omename, email) sends new password to the given user
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Successful response for ResetPasswordRequest. If no valid user with matching email is found, an ERR will be returned.
Bases: omero.cmd.ResponsePrx
Bases: Ice.Object
Bases: IcePy.ObjectPrx
Bases: omero.cmd.Request
Requests an email to be send to all users of the omero determines inactive users, an active members of given groups and/or specific users. examples: - omero.cmd.SendEmailRequest(subject, body, everyone=True) sends message to everyone who has email set and is an active user - omero.cmd.SendEmailRequest(subject, body, everyone=True, inactive=True) sends message to everyone who has email set, even inactive users - omero.cmd.SendEmailRequest(subject, body, groupIds=[...], userIds=[...] ) sends email to active members of given groups and selected users - extra=[...] allows to set extra email address if not in DB
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
Successful response for SendEmailRequest. Contains a list of invalid users that has no email address set. If no recipients or invalid users found, an ERR will be returned. - invalidusers is a list of userIds that email didn’t pass criteria such as was empty or less then 5 characters - invalidemails is a list of email addresses that send email failed - total is a total number of email in the pull to be sent. - success is a number of emails that were sent successfully.
Bases: omero.cmd.ResponsePrx
Bases: Glacier2.Session
Starting point for all command-based OMERO.blitz interaction.
Bases: Glacier2.SessionPrx
Bases: omero.cmd.GraphModify2
Perform a request skipping the top-most model objects in the graph. This permits operating upon the (possibly indirect) children of given objects. The arguments of this SkipHead request override those of the given request only until the targeted children are reached, except that if this SkipHead request’s dryRun is set to true then the dryRun override persists throughout the operation. The response from SkipHead is as from the given request. Members: startFrom – Classes of model objects from which to actually start the operation. These are children, directly or indirectly, of the target objects. These children become the true target objects of the underlying request. request – The operation to perform on the targeted model objects. The given request’s targetObjects property is ignored: it is the SkipHead request that specifies the parent objects. Only specific request types are supported (those implementing WrappableRequest).
Bases: omero.cmd.GraphModify2Prx
Bases: Ice.EnumBase
Bases: Ice.Object
Bases: IcePy.ObjectPrx
Bases: omero.cmd.Request
Diagnostic command which can be used to see the overhead of callbacks. The number of steps and the simulated workload can be specified. Members: steps – Number of steps that will be run by this command. Value is limited by the overall invocation time (5 minutes) as well as total number of calls (e.g. 100000) millisPerStep – Number of millis to wait. This value simulates activity on the server. Value is limited by the overall invocation time (5 minutes).
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.ERR
Bases: omero.cmd.ERRPrx
Bases: omero.cmd.Request
Proposes a change to one or both of the timeToLive and timeToIdle properties of a live session. The session uuid cannot be null. If either other argument is null, it will be ignored. Otherwise, the long value will be interpreted as the the millisecond value which should be set. Non-administrators will not be able to reduce current values. No special response is returned, but an omero.cmd.OK counts as success.
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Request
Request to determine the original files associated with the given image. The image must have an associated Pixels object. Different response objects are returned depending on if the image is FS or pre-FS. Members: imageId – an image ID
Bases: omero.cmd.RequestPrx
Bases: omero.cmd.Response
The used files associated with an FS image. Members: binaryFilesThisSeries – The original file IDs of any binary files associated with the image’s particular series. binaryFilesOtherSeries – The original file IDs of any binary files associated with the image’s fileset but not with its particular series. companionFilesThisSeries – The original file IDs of any companion files associated with the image’s particular series. companionFilesOtherSeries – The original file IDs of any companion files associated with the image’s fileset but not with its particular series.
Bases: omero.cmd.Response
The used files associated with a pre-FS image. Members: archivedFiles – The original file IDs of any archived files associated with the image. companionFiles – The original file IDs of any companion files associated with the image. originalMetadataFiles – The original file IDs of any original metadata files associated with the image.
Bases: omero.cmd.ResponsePrx
Bases: omero.cmd.ResponsePrx