flywheel.models.gear
Gear
Bases: object
author property writable
Gets the author of this Gear.
The author of this gear.
Returns:
| Type | Description |
|---|---|
str | The author of this Gear |
capabilities property writable
Gets the capabilities of this Gear.
Returns:
| Type | Description |
|---|---|
list[str] | The capabilities of this Gear |
cite property writable
Gets the cite of this Gear.
(optional) Any citations relevant to the algorithm(s) or work present in the gear.
Returns:
| Type | Description |
|---|---|
str | The cite of this Gear |
command property writable
Gets the command of this Gear.
If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec.
Returns:
| Type | Description |
|---|---|
str | The command of this Gear |
config property writable
Gets the config of this Gear.
Returns:
| Type | Description |
|---|---|
GearConfig | The config of this Gear |
custom property writable
Gets the custom of this Gear.
Returns:
| Type | Description |
|---|---|
GearCustom | The custom of this Gear |
description property writable
Gets the description of this Gear.
A brief description of the gear's purpose. Ideally 1-4 sentences.
Returns:
| Type | Description |
|---|---|
str | The description of this Gear |
environment property writable
Gets the environment of this Gear.
Returns:
| Type | Description |
|---|---|
GearEnvironment | The environment of this Gear |
flywheel property writable
Gets the flywheel of this Gear.
Returns:
| Type | Description |
|---|---|
object | The flywheel of this Gear |
inputs property writable
Gets the inputs of this Gear.
Returns:
| Type | Description |
|---|---|
GearInputs | The inputs of this Gear |
label property writable
Gets the label of this Gear.
The human-friendly name of this gear.
Returns:
| Type | Description |
|---|---|
str | The label of this Gear |
license property writable
Gets the license of this Gear.
Software license of the gear
Returns:
| Type | Description |
|---|---|
str | The license of this Gear |
maintainer property writable
Gets the maintainer of this Gear.
(optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer.
Returns:
| Type | Description |
|---|---|
str | The maintainer of this Gear |
name property writable
Gets the name of this Gear.
The identification of this gear.
Returns:
| Type | Description |
|---|---|
str | The name of this Gear |
source property writable
Gets the source of this Gear.
A valid URI, or empty string.
Returns:
| Type | Description |
|---|---|
str | The source of this Gear |
url property writable
Gets the url of this Gear.
A valid URI, or empty string.
Returns:
| Type | Description |
|---|---|
str | The url of this Gear |
version property writable
Gets the version of this Gear.
A human-friendly string explaining the release version of this gear. Example: 3.2.1
Returns:
| Type | Description |
|---|---|
str | The version of this Gear |
__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__(author=None, capabilities=None, maintainer=None, cite=None, config=None, custom=None, description=None, environment=None, flywheel=None, command=None, inputs=None, label=None, license=None, name=None, source=None, url=None, version=None)
Gear - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
author | (str, optional) | The author of this gear., defaults to None | None |
capabilities | (list[str], optional) | , defaults to None | None |
maintainer | (str, optional) | (optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer., defaults to None | None |
cite | (str, optional) | (optional) Any citations relevant to the algorithm(s) or work present in the gear., defaults to None | None |
config | (GearConfig, optional) | , defaults to None | None |
custom | (GearCustom, optional) | , defaults to None | None |
description | (str, optional) | A brief description of the gear's purpose. Ideally 1-4 sentences., defaults to None | None |
environment | (GearEnvironment, optional) | , defaults to None | None |
flywheel | (object, optional) | , defaults to None | None |
command | (str, optional) | If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec., defaults to None | None |
inputs | (GearInputs, optional) | , defaults to None | None |
label | (str, optional) | The human-friendly name of this gear., defaults to None | None |
license | (str, optional) | Software license of the gear, defaults to None | None |
name | (str, optional) | The identification of this gear., defaults to None | None |
source | (str, optional) | A valid URI, or empty string., defaults to None | None |
url | (str, optional) | A valid URI, or empty string., defaults to None | None |
version | (str, optional) | A human-friendly string explaining the release version of this gear. Example: 3.2.1, 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