omero.cmd package

Subpackages

• omero.cmd.graphs package
  • Module contents

Module contents

Simplified API that is intended for passing

class omero.cmd.Chgrp(type='', id=0, options=None, grp=0)

Bases: omero.cmd.GraphModify

_ice_type = <IcePy.TypeInfo object at 0x124ac1c8>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac3c0>

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

_ice_type = <IcePy.TypeInfo object at 0x124ac3f0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ChgrpPrx

Bases: omero.cmd.GraphModifyPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.ChgrpRsp

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x124ac1f8>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.ChgrpRspPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.Chmod(type='', id=0, options=None, permissions='')

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

_ice_type = <IcePy.TypeInfo object at 0x124ac228>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.ChmodPrx

Bases: omero.cmd.GraphModifyPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.ChmodRsp

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x124ac258>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.ChmodRspPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.Chown(type='', id=0, options=None, user=0)

Bases: omero.cmd.GraphModify

_ice_type = <IcePy.TypeInfo object at 0x124ac288>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.Chown2(targetObjects=None, childOptions=None, dryRun=False, userId=0)

Bases: omero.cmd.GraphModify2

Change the ownership of model objects. The user must be either an administrator, or the owner of the objects with the target user a member of the objects’ group.

_ice_type = <IcePy.TypeInfo object at 0x124ac420>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.Chown2Response(includedObjects=None, deletedObjects=None)

Bases: omero.cmd.OK

Result of changing the ownership of model objects.

_ice_type = <IcePy.TypeInfo object at 0x124ac450>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ChownPrx

Bases: omero.cmd.GraphModifyPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.ChownRsp

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x124ac2b8>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.ChownRspPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.CmdCallback

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x4aef240>

_op_finished = <IcePy.Operation object at 0x4aef270>

_op_step = <IcePy.Operation object at 0x4aef258>

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.

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.

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.

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)

step(complete, total, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.Delete(type='', id=0, options=None)

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac2e8>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.Delete2(targetObjects=None, childOptions=None, dryRun=False)

Bases: omero.cmd.GraphModify2

Delete model objects.

_ice_type = <IcePy.TypeInfo object at 0x124ac498>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.Delete2Response(deletedObjects=None)

Bases: omero.cmd.OK

Result of deleting model objects.

_ice_type = <IcePy.TypeInfo object at 0x124ac4c8>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.DeletePrx

Bases: omero.cmd.GraphModifyPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.DeleteRsp(warning='', undeletedFiles=None, steps=0, scheduledDeletes=0, actualDeletes=0)

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac318>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.DeleteRspPrx

Bases: omero.cmd.OKPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

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

_ice_type = <IcePy.TypeInfo object at 0x124ac090>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.DiskUsagePrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

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 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 at 0x124ac0c0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.DoAll(requests=None, contexts=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x11f53d50>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.DoAllRsp(responses=None, status=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object at 0x11f53d80>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ERR(category='', name='', parameters=None)

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x4aef1c8>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.FindHandles(limit=0, include=None, exclude=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x11f53e70>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.FindHandlesRsp(handles=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object at 0x11f53ea0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.GraphConstraintERR(category='', name='', parameters=None, constraints=None)

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac120>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.GraphConstraintERRPrx

Bases: omero.cmd.ERRPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac528>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.GraphModify(type='', id=0, options=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x124ac0f0>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.GraphModify2(targetObjects=None, childOptions=None, dryRun=False)

Bases: omero.cmd.Request

Base class for new requests for operating upon the model object graph.

_ice_type = <IcePy.TypeInfo object at 0x124ac390>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.GraphModify2Prx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.GraphModifyPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.GraphSpecList

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x124ac168>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.GraphSpecListPrx

Bases: omero.cmd.RequestPrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.GraphSpecListRsp(list=None)

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x124ac198>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.GraphSpecListRspPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.Handle

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x4aef090>

_op_addCallback = <IcePy.Operation object at 0x4aef288>

_op_cancel = <IcePy.Operation object at 0x4aef300>

_op_close = <IcePy.Operation object at 0x4aef318>

_op_getRequest = <IcePy.Operation object at 0x4aef2b8>

_op_getResponse = <IcePy.Operation object at 0x4aef2d0>

_op_getStatus = <IcePy.Operation object at 0x4aef2e8>

_op_removeCallback = <IcePy.Operation object at 0x4aef2a0>

addCallback(cb, current=None)

Add a callback for notifications.

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.

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.

getRequest(current=None)

Returns the request object that was used to initialize this handle. Never null.

getResponse(current=None)

Returns a response if this handle has finished execution, otherwise returns null.

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.

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

removeCallback(cb, current=None)

Remove callback for notifications.

class omero.cmd.HandlePrx

Bases: IcePy.ObjectPrx

Add a callback for notifications.

addCallback(cb, _ctx=None)

addCallback_async(_cb, 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)

cancel_async(_cb, _ctx=None)

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

close(_ctx=None)

close_async(_cb, _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)

getRequest_async(_cb, _ctx=None)

getResponse(_ctx=None)

getResponse_async(_cb, _ctx=None)

getStatus(_ctx=None)

getStatus_async(_cb, _ctx=None)

removeCallback(cb, _ctx=None)

removeCallback_async(_cb, cb, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.ListRequests

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x11f53db0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ListRequestsRsp(list=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object at 0x11f53de0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ManageImageBinaries(imageId=0, togglePixels=False, deletePyramid=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 at 0x124ac030>

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 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 at 0x124ac060>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.OK

Bases: omero.cmd.Response

_ice_type = <IcePy.TypeInfo object at 0x4aef198>

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 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 at 0x11f53f00>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.OriginalMetadataResponse(filesetId=None, fileAnnotationId=None, globalMetadata=None, seriesMetadata=None)

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.

_ice_type = <IcePy.TypeInfo object at 0x11f53f30>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.OriginalMetadataResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.PopStatus(limit=0, include=None, exclude=None)

Bases: omero.cmd.Request

_ice_type = <IcePy.TypeInfo object at 0x11f53e10>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.PopStatusRsp(list=None)

Bases: omero.cmd.OK

_ice_type = <IcePy.TypeInfo object at 0x11f53e40>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.Request

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x4aef120>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ResetPasswordRequest(omename='', email='')

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

_ice_type = <IcePy.TypeInfo object at 0x11f53cf0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.ResetPasswordResponse

Bases: omero.cmd.Response

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

_ice_type = <IcePy.TypeInfo object at 0x11f53d20>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.ResetPasswordResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.Response

Bases: Ice.Object

_ice_type = <IcePy.TypeInfo object at 0x4aef168>

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 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 at 0x124ac558>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.SendEmailResponse(total=0, success=0, invalidusers=None, invalidemails=None)

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.

_ice_type = <IcePy.TypeInfo object at 0x124ac588>

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 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 0x4aef360>

_op_submit = <IcePy.Operation object at 0x4aef378>

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)

submit(req, _ctx=None)

submit_async(_cb, 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.

_ice_type = <IcePy.TypeInfo object at 0x124ac4f8>

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 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 0x4aef0d8>

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

_ice_type = <IcePy.TypeInfo object at 0x11f53ed0>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.Unknown(category='', name='', parameters=None)

Bases: omero.cmd.ERR

_ice_type = <IcePy.TypeInfo object at 0x4aef1f8>

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

_ice_type = <IcePy.TypeInfo object at 0x11f53f60>

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 uncheckedCast(proxy, facet=None)

class omero.cmd.UsedFilesResponse(binaryFilesThisSeries=None, binaryFilesOtherSeries=None, companionFilesThisSeries=None, companionFilesOtherSeries=None)

Bases: omero.cmd.Response

The used files associated with an FS image.

_ice_type = <IcePy.TypeInfo object at 0x11f53fc0>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.UsedFilesResponsePreFs(archivedFiles=None, companionFiles=None, originalMetadataFiles=None)

Bases: omero.cmd.Response

The used files associated with a pre-FS image.

_ice_type = <IcePy.TypeInfo object at 0x11f53f90>

ice_id(current=None)

ice_ids(current=None)

static ice_staticId()

class omero.cmd.UsedFilesResponsePreFsPrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)

class omero.cmd.UsedFilesResponsePrx

Bases: omero.cmd.ResponsePrx

static checkedCast(proxy, facetOrCtx=None, _ctx=None)

static uncheckedCast(proxy, facet=None)