Skip to content

flywheel.models.valid_protocol

ValidProtocol

Bases: object

completion_tags property writable

Gets the completion_tags of this ValidProtocol.

Returns:

Type Description
list[str]

The completion_tags of this ValidProtocol

created property writable

Gets the created of this ValidProtocol.

Returns:

Type Description
datetime

The created of this ValidProtocol

esignature_config property writable

Gets the esignature_config of this ValidProtocol.

Returns:

Type Description
ProtocolESignatureConfig

The esignature_config of this ValidProtocol

form property writable

Gets the form of this ValidProtocol.

Returns:

Type Description
CustomForm

The form of this ValidProtocol

id property writable

Gets the id of this ValidProtocol.

Returns:

Type Description
str

The id of this ValidProtocol

label property writable

Gets the label of this ValidProtocol.

Returns:

Type Description
str

The label of this ValidProtocol

modified property writable

Gets the modified of this ValidProtocol.

Returns:

Type Description
datetime

The modified of this ValidProtocol

modified_by property writable

Gets the modified_by of this ValidProtocol.

Returns:

Type Description
Origin

The modified_by of this ValidProtocol

notes property writable

Gets the notes of this ValidProtocol.

Returns:

Type Description
str

The notes of this ValidProtocol

parent_ref property writable

Gets the parent_ref of this ValidProtocol.

Returns:

Type Description
ContainerReference

The parent_ref of this ValidProtocol

protocol_config property writable

Gets the protocol_config of this ValidProtocol.

Returns:

Type Description
ReaderTaskConfig

The protocol_config of this ValidProtocol

replaced property writable

Gets the replaced of this ValidProtocol.

Returns:

Type Description
datetime

The replaced of this ValidProtocol

status property writable

Gets the status of this ValidProtocol.

Returns:

Type Description
ProtocolStatus

The status of this ValidProtocol

task_type property writable

Gets the task_type of this ValidProtocol.

Returns:

Type Description
str

The task_type of this ValidProtocol

version property writable

Gets the version of this ValidProtocol.

Returns:

Type Description
int

The version of this ValidProtocol

workflow property writable

Gets the workflow of this ValidProtocol.

Returns:

Type Description
union[SingleWorkflow,LegacyAdjudicationWorkflow]

The workflow of this ValidProtocol

__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, created=None, modified=None, replaced=None, version=None, status=None, parent_ref=None, modified_by=None, notes=None, protocol_config=None, form=None, task_type=None, completion_tags=None, esignature_config=None, workflow=None)

ValidProtocol - a model defined in Swagger

Parameters:

Name Type Description Default
id (str, optional)

, defaults to None

None
label (str, 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
modified_by (Origin, optional)

, defaults to None

None
notes (str, optional)

, defaults to None

None
protocol_config (ReaderTaskConfig, optional)

, defaults to None

None
form (CustomForm, optional)

, defaults to None

None
task_type (str, optional)

, defaults to None

None
completion_tags (list[str], optional)

, defaults to None

None
esignature_config (ProtocolESignatureConfig, optional)

, defaults to None

None
workflow (union[SingleWorkflow, LegacyAdjudicationWorkflow], 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