omero.cmd package

Module contents

Simplified API that is intended for passing

class omero.cmd.Chgrp2(targetObjects=None, childOptions=None, dryRun=False, groupId=0)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chgrp2Prx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Chgrp2Response(includedObjects=None, deletedObjects=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chgrp2ResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Chmod2(targetObjects=None, childOptions=None, dryRun=False, permissions='')

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chmod2Prx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Chmod2Response(includedObjects=None, deletedObjects=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chmod2ResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Chown2(targetObjects=None, childOptions=None, dryRun=False, userId=0, targetUsers=None)

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. targetUsers – The users who should have all their data targeted.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chown2Prx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Chown2Response(includedObjects=None, deletedObjects=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Chown2ResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.CmdCallback

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x35613a8>
_op_finished = <IcePy.Operation object at 0x35613d8>
_op_step = <IcePy.Operation object at 0x35613c0>
finished(rsp, s, current=None)

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.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
step(complete, total, current=None)

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.

class omero.cmd.CmdCallbackPrx

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.

begin_finished(rsp, s, _response=None, _ex=None, _sent=None, _ctx=None)
begin_step(complete, total, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_finished(_r)
end_step(_r)
finished(rsp, s, _ctx=None)
static ice_staticId()
step(complete, total, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.cmd.CurrentSessionsRequest

Bases: omero.cmd.Request

Argument-less request that will produce a CurrentSessionsResponse if no omero.cmd.ERR occurs.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.CurrentSessionsRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.CurrentSessionsResponse(sessions=None, contexts=None, data=None)

Bases: omero.cmd.OK

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 {@code omero.api.ISession.getSession} when joined to that session. Similarly, the contexts field contains the value that would be returned by a call to {@code omero.api.IAdmin.getEventContext}. For non-administrators, most values for all sessions other than those belonging to that user will be null. 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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.CurrentSessionsResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Delete2(targetObjects=None, childOptions=None, dryRun=False, typesToIgnore=None)

Bases: omero.cmd.GraphModify2

Delete model objects. Members: typesToIgnore – Ignore in the operation all objects of these types.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Delete2Prx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Delete2Response(deletedObjects=None)

Bases: omero.cmd.OK

Result of deleting model objects. Members: deletedObjects – The model objects that were deleted.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.Delete2ResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DiskUsage(classes=None, objects=None)

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, Folder, Screen, Plate, Well, WellSample, Image, Pixels, Annotation, Job, Fileset, OriginalFile.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DiskUsage2(targetObjects=None, targetClasses=None)

Bases: omero.cmd.GraphQuery

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, Folder, Screen, Plate, Well, WellSample, Image, Pixels, Annotation, Job, Fileset, OriginalFile.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DiskUsage2Prx

Bases: omero.cmd.GraphQueryPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DiskUsage2Response(fileCountByReferer=None, bytesUsedByReferer=None, totalFileCount=None, totalBytesUsed=None)

Bases: omero.cmd.OK

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DiskUsage2ResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DiskUsagePrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DiskUsageResponse(fileCountByReferer=None, bytesUsedByReferer=None, totalFileCount=None, totalBytesUsed=None)

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 referrers 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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DiskUsageResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DoAll(requests=None, contexts=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DoAllPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DoAllRsp(responses=None, status=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DoAllRspPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Duplicate(targetObjects=None, childOptions=None, dryRun=False, typesToDuplicate=None, typesToReference=None, typesToIgnore=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DuplicatePrx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.DuplicateResponse(duplicates=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.DuplicateResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ERR(category='', name='', parameters=None)

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x3561330>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ERRPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindChildren(targetObjects=None, typesOfChildren=None, stopBefore=None)

Bases: omero.cmd.GraphQuery

Identify the children or contents of model objects. Traverses the model graph to identify indirect relationships. Members: typesOfChildren – The types of children being sought. stopBefore – Classes of model objects to exclude from the recursive search. Search does not include or pass such objects. For efficiency the server automatically excludes various classes depending on the other arguments of the request.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindChildrenPrx

Bases: omero.cmd.GraphQueryPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindHandles(limit=0, include=None, exclude=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindHandlesPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindHandlesRsp(handles=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindHandlesRspPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindParents(targetObjects=None, typesOfParents=None, stopBefore=None)

Bases: omero.cmd.GraphQuery

Identify the parents or containers of model objects. Traverses the model graph to identify indirect relationships. Members: typesOfParents – The types of parents being sought. stopBefore – Classes of model objects to exclude from the recursive search. Search does not include or pass such objects. For efficiency the server automatically excludes various classes depending on the other arguments of the request.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindParentsPrx

Bases: omero.cmd.GraphQueryPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindPyramids(littleEndian=None, importedAfter=None, checkEmptyFile=False, limit=0)

Bases: omero.cmd.Request

Requests all pyramids files. A FindPyramidsResponse will be returned under normal conditions, otherwise a ERR will be returned. Members: littleEndian – Retrieves the pyramids with little endian true or false. If unset, both will be retrieved. importedAfter – Retrieves the pyramids created after a specified time if set. checkEmptyFile – Retrieves the pyramids of length 0 if true limit – The maximum number of files to find. No limit will be applied if set to 0 or to a negative value.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindPyramidsPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FindPyramidsResponse(pyramidFiles=None)

Bases: omero.cmd.OK

Returns the image Ids corresponding to the pyramid files. A FindPyramidsResponse will be returned under normal conditions, otherwise a ERR will be returned. Members: pyramidFiles – The image IDs corresponding to the pyramid

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FindPyramidsResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FoundChildren(children=None)

Bases: omero.cmd.OK

Result of identifying the children or contents of model objects. Members: children – The children that were identified.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FoundChildrenPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.FoundParents(parents=None)

Bases: omero.cmd.OK

Result of identifying the parents or containers of model objects. Members: parents – The parents that were identified.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.FoundParentsPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.GraphException(category='', name='', parameters=None, message='')

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.GraphExceptionPrx

Bases: omero.cmd.ERRPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.GraphModify2(targetObjects=None, childOptions=None, dryRun=False)

Bases: omero.cmd.GraphQuery

Base class for new requests for modifying the model object graph. Members: 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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.GraphModify2Prx

Bases: omero.cmd.GraphQueryPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.GraphQuery(targetObjects=None)

Bases: omero.cmd.Request

Base class for new requests for reading the model object graph. Members: targetObjects – The model objects upon which to operate. Related model objects may also be targeted.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.GraphQueryPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Handle

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x35611f8>
_op_addCallback = <IcePy.Operation object at 0x35613f0>
_op_cancel = <IcePy.Operation object at 0x3561468>
_op_close = <IcePy.Operation object at 0x3561480>
_op_getRequest = <IcePy.Operation object at 0x3561420>
_op_getResponse = <IcePy.Operation object at 0x3561438>
_op_getStatus = <IcePy.Operation object at 0x3561450>
_op_removeCallback = <IcePy.Operation object at 0x3561408>
addCallback(cb, current=None)

Add a callback for notifications. Arguments: cb – current – The Current object for the invocation.

cancel(current=None)

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.

close(current=None)

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.

getRequest(current=None)

Returns the request object that was used to initialize this handle. Never null. Arguments: current – The Current object for the invocation.

getResponse(current=None)

Returns a response if this handle has finished execution, otherwise returns null. Arguments: current – The Current object for the invocation.

getStatus(current=None)

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.

ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
removeCallback(cb, current=None)

Remove callback for notifications. Arguments: cb – current – The Current object for the invocation.

class omero.cmd.HandlePrx

Bases: IcePy.ObjectPrx

Add a callback for notifications. Arguments: cb – _ctx – The request context for the invocation.

addCallback(cb, _ctx=None)
begin_addCallback(cb, _response=None, _ex=None, _sent=None, _ctx=None)
begin_cancel(_response=None, _ex=None, _sent=None, _ctx=None)
begin_close(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getRequest(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getResponse(_response=None, _ex=None, _sent=None, _ctx=None)
begin_getStatus(_response=None, _ex=None, _sent=None, _ctx=None)
begin_removeCallback(cb, _response=None, _ex=None, _sent=None, _ctx=None)
cancel(_ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
close(_ctx=None)
end_addCallback(_r)
end_cancel(_r)
end_close(_r)
end_getRequest(_r)
end_getResponse(_r)
end_getStatus(_r)
end_removeCallback(_r)
getRequest(_ctx=None)
getResponse(_ctx=None)
getStatus(_ctx=None)
static ice_staticId()
removeCallback(cb, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.cmd.LegalGraphTargets(request=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.LegalGraphTargetsPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.LegalGraphTargetsResponse(targets=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.LegalGraphTargetsResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ListRequests

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ListRequestsPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ListRequestsRsp(list=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ListRequestsRspPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ManageImageBinaries(imageId=0, togglePixels=False, deletePyramid=False, deleteThumbnails=False)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ManageImageBinariesPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ManageImageBinariesResponse(filesetId=None, archivedFiles=None, pixelsPresent=False, pyramidPresent=False, archivedSize=0, pixelSize=0, pyramidSize=0, thumbnailSize=0)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ManageImageBinariesResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.OK

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x3561300>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.OKPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.OriginalMetadataRequest(imageId=0)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.OriginalMetadataRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.OriginalMetadataResponse(filesetId=None, fileAnnotationId=None, globalMetadata=None, seriesMetadata=None)

Bases: omero.cmd.OK

Successful response for OriginalMetadataRequest. Contains both the global and the series metadata as maps. Only one of {@code filesetId} or {@code filesetAnnotationId} will be set. Pre-FS images will have {@code filesetAnnotationId} set; otherwise {@code 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.FileAnnotation 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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.OriginalMetadataResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.PopStatus(limit=0, include=None, exclude=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.PopStatusPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.PopStatusRsp(list=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.PopStatusRspPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Request

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x3561288>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.RequestPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ResetPasswordRequest(omename='', email='')

Bases: omero.cmd.Request

Requests a reset password for the given user. The user must not be an administrator. examples: - omero.cmd.ResetPasswordRequest(omename, email) sends new password to the given user

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ResetPasswordRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.ResetPasswordResponse

Bases: omero.cmd.OK

Successful response for ResetPasswordRequest. If no valid user with matching email is found, an ERR will be returned.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ResetPasswordResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Response

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x35612d0>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.ResponsePrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.SendEmailRequest(subject='', body='', html=False, userIds=None, groupIds=None, extra=None, inactive=False, everyone=False)

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

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.SendEmailRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.SendEmailResponse(total=0, success=0, invalidusers=None, invalidemails=None)

Bases: omero.cmd.Response

Successful response for {@code SendEmailRequest}. Contains a list of invalid users that has no email address set. If no recipients or invalid users found, an {@code 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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.SendEmailResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Session

Bases: Glacier2.Session

Starting point for all command-based OMERO.blitz interaction.

_ice_type = <IcePy.TypeInfo object at 0x35614c8>
_op_submit = <IcePy.Operation object at 0x35614e0>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
submit_async(_cb, req, current=None)
class omero.cmd.SessionPrx

Bases: Glacier2.SessionPrx

begin_submit(req, _response=None, _ex=None, _sent=None, _ctx=None)
static checkedCast(proxy, facetOrCtx=None, _ctx=None)
end_submit(_r)
static ice_staticId()
submit(req, _ctx=None)
static uncheckedCast(proxy, facet=None)
class omero.cmd.SkipHead(targetObjects=None, childOptions=None, dryRun=False, startFrom=None, request=None)

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).

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.SkipHeadPrx

Bases: omero.cmd.GraphModify2Prx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.State(_n, _v)

Bases: Ice.EnumBase

ACTIVE = ACTIVE
ALL = ALL
CANCELLED = CANCELLED
FAILURE = FAILURE
INACTIVE = INACTIVE
SUCCESS = SUCCESS
_enumerators = {0: ALL, 1: ACTIVE, 2: INACTIVE, 3: SUCCESS, 4: FAILURE, 5: CANCELLED}
classmethod valueOf(_n)
class omero.cmd.Status(source=None, category='', name='', flags=None, parameters=None, currentStep=0, steps=0, startTime=0, stepStartTimes=None, stepStopTimes=None, stopTime=0)

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x3561240>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.StatusPrx

Bases: IcePy.ObjectPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Timing(steps=0, millisPerStep=0)

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).

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.TimingPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.Unknown(category='', name='', parameters=None)

Bases: omero.cmd.ERR

_ice_type = <IcePy.TypeInfo object at 0x3561360>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.UnknownPrx

Bases: omero.cmd.ERRPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.UpdateSessionTimeoutRequest(session='', timeToLive=None, timeToIdle=None)

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.UpdateSessionTimeoutRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.UsedFilesRequest(imageId=0)

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

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.UsedFilesRequestPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.UsedFilesResponse(binaryFilesThisSeries=None, binaryFilesOtherSeries=None, companionFilesThisSeries=None, companionFilesOtherSeries=None)

Bases: omero.cmd.OK

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.UsedFilesResponsePreFs(archivedFiles=None, companionFiles=None, originalMetadataFiles=None)

Bases: omero.cmd.OK

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.

_ice_type = <IcePy.TypeInfo object>
ice_id(current=None)
ice_ids(current=None)
static ice_staticId()
class omero.cmd.UsedFilesResponsePreFsPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)
class omero.cmd.UsedFilesResponsePrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)
static ice_staticId()
static uncheckedCast(proxy, facet=None)