flywheel.models.protocol
Protocol
Bases: object
completion_tags property writable
Gets the completion_tags of this Protocol.
Returns:
| Type | Description |
|---|---|
list[str] | The completion_tags of this Protocol |
created property writable
Gets the created of this Protocol.
Returns:
| Type | Description |
|---|---|
datetime | The created of this Protocol |
esignature_config property writable
Gets the esignature_config of this Protocol.
Returns:
| Type | Description |
|---|---|
ProtocolESignatureConfig | The esignature_config of this Protocol |
form property writable
Gets the form of this Protocol.
Returns:
| Type | Description |
|---|---|
CustomForm | The form of this Protocol |
id property writable
Gets the id of this Protocol.
Returns:
| Type | Description |
|---|---|
str | The id of this Protocol |
label property writable
Gets the label of this Protocol.
Returns:
| Type | Description |
|---|---|
str | The label of this Protocol |
modified property writable
Gets the modified of this Protocol.
Returns:
| Type | Description |
|---|---|
datetime | The modified of this Protocol |
modified_by property writable
Gets the modified_by of this Protocol.
Returns:
| Type | Description |
|---|---|
Origin | The modified_by of this Protocol |
notes property writable
Gets the notes of this Protocol.
Returns:
| Type | Description |
|---|---|
str | The notes of this Protocol |
parent_ref property writable
Gets the parent_ref of this Protocol.
Returns:
| Type | Description |
|---|---|
ContainerReference | The parent_ref of this Protocol |
protocol_config property writable
Gets the protocol_config of this Protocol.
Returns:
| Type | Description |
|---|---|
ReaderTaskConfig | The protocol_config of this Protocol |
replaced property writable
Gets the replaced of this Protocol.
Returns:
| Type | Description |
|---|---|
datetime | The replaced of this Protocol |
status property writable
Gets the status of this Protocol.
Returns:
| Type | Description |
|---|---|
ProtocolStatus | The status of this Protocol |
task_type property writable
Gets the task_type of this Protocol.
Returns:
| Type | Description |
|---|---|
str | The task_type of this Protocol |
version property writable
Gets the version of this Protocol.
Returns:
| Type | Description |
|---|---|
int | The version of this Protocol |
workflow property writable
Gets the workflow of this Protocol.
Returns:
| Type | Description |
|---|---|
union[SingleWorkflow,AdjudicationWorkflow] | The workflow of this Protocol |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(id=None, label=None, form=None, protocol_config=None, created=None, modified=None, replaced=None, version=None, status=None, parent_ref=None, task_type=None, completion_tags=None, notes=None, esignature_config=None, modified_by=None, workflow=None)
Protocol - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id | (str, optional) | , defaults to None | None |
label | (str, optional) | , defaults to None | None |
form | (CustomForm, optional) | , defaults to None | None |
protocol_config | (ReaderTaskConfig, optional) | , defaults to None | None |
created | (datetime, optional) | , defaults to None | None |
modified | (datetime, optional) | , defaults to None | None |
replaced | (datetime, optional) | , defaults to None | None |
version | (int, optional) | , defaults to None | None |
status | (ProtocolStatus, optional) | , defaults to None | None |
parent_ref | (ContainerReference, optional) | , defaults to None | None |
task_type | (str, optional) | , defaults to None | None |
completion_tags | (list[str], optional) | , defaults to None | None |
notes | (str, optional) | , defaults to None | None |
esignature_config | (ProtocolESignatureConfig, optional) | , defaults to None | None |
modified_by | (Origin, optional) | , defaults to None | None |
workflow | (union[SingleWorkflow, AdjudicationWorkflow], optional) | , defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object