flywheel-sdk 21.3.0__py3-none-any.whl → 21.4.0__py3-none-any.whl

flywheel/models/gear.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -88,7 +81,43 @@ class Gear(object):
     }
 
     def __init__(self, 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):  # noqa: E501
-        """Gear - a model defined in Swagger"""
+        """Gear - a model defined in Swagger
+
+        :param author: The author of this gear., defaults to None
+        :type author: str, optional
+        :param capabilities:, defaults to None
+        :type capabilities: list[str], optional
+        :param maintainer: (optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer., defaults to None
+        :type maintainer: str, optional
+        :param cite: (optional) Any citations relevant to the algorithm(s) or work present in the gear., defaults to None
+        :type cite: str, optional
+        :param config:, defaults to None
+        :type config: GearConfig, optional
+        :param custom:, defaults to None
+        :type custom: GearCustom, optional
+        :param description: A brief description of the gear's purpose. Ideally 1-4 sentences., defaults to None
+        :type description: str, optional
+        :param environment:, defaults to None
+        :type environment: GearEnvironment, optional
+        :param flywheel:, defaults to None
+        :type flywheel: object, optional
+        :param command: If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec., defaults to None
+        :type command: str, optional
+        :param inputs:, defaults to None
+        :type inputs: GearInputs, optional
+        :param label: The human-friendly name of this gear., defaults to None
+        :type label: str, optional
+        :param license: Software license of the gear, defaults to None
+        :type license: str, optional
+        :param name: The identification of this gear., defaults to None
+        :type name: str, optional
+        :param source: A valid URI, or empty string., defaults to None
+        :type source: str, optional
+        :param url: A valid URI, or empty string., defaults to None
+        :type url: str, optional
+        :param version: A human-friendly string explaining the release version of this gear. Example: 3.2.1, defaults to None
+        :type version: str, optional
+        """
         super(Gear, self).__init__()
 
         self._author = None
@@ -142,7 +171,7 @@ class Gear(object):
 
         The author of this gear.
 
-        :return: The author of this Gear.
+        :return: The author of this Gear
         :rtype: str
         """
         return self._author
@@ -153,8 +182,8 @@ class Gear(object):
 
         The author of this gear.
 
-        :param author: The author of this Gear.  # noqa: E501
-        :type: str
+        :param author: The author of this Gear
+        :type author: str
         """
 
         self._author = author
@@ -164,7 +193,7 @@ class Gear(object):
         """Gets the capabilities of this Gear.
 
 
-        :return: The capabilities of this Gear.
+        :return: The capabilities of this Gear
         :rtype: list[str]
         """
         return self._capabilities
@@ -174,8 +203,8 @@ class Gear(object):
         """Sets the capabilities of this Gear.
 
 
-        :param capabilities: The capabilities of this Gear.  # noqa: E501
-        :type: list[str]
+        :param capabilities: The capabilities of this Gear
+        :type capabilities: list[str]
         """
 
         self._capabilities = capabilities
@@ -186,7 +215,7 @@ class Gear(object):
 
         (optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer.
 
-        :return: The maintainer of this Gear.
+        :return: The maintainer of this Gear
         :rtype: str
         """
         return self._maintainer
@@ -197,8 +226,8 @@ class Gear(object):
 
         (optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer.
 
-        :param maintainer: The maintainer of this Gear.  # noqa: E501
-        :type: str
+        :param maintainer: The maintainer of this Gear
+        :type maintainer: str
         """
 
         self._maintainer = maintainer
@@ -209,7 +238,7 @@ class Gear(object):
 
         (optional) Any citations relevant to the algorithm(s) or work present in the gear.
 
-        :return: The cite of this Gear.
+        :return: The cite of this Gear
         :rtype: str
         """
         return self._cite
@@ -220,8 +249,8 @@ class Gear(object):
 
         (optional) Any citations relevant to the algorithm(s) or work present in the gear.
 
-        :param cite: The cite of this Gear.  # noqa: E501
-        :type: str
+        :param cite: The cite of this Gear
+        :type cite: str
         """
 
         self._cite = cite
@@ -231,7 +260,7 @@ class Gear(object):
         """Gets the config of this Gear.
 
 
-        :return: The config of this Gear.
+        :return: The config of this Gear
         :rtype: GearConfig
         """
         return self._config
@@ -241,8 +270,8 @@ class Gear(object):
         """Sets the config of this Gear.
 
 
-        :param config: The config of this Gear.  # noqa: E501
-        :type: GearConfig
+        :param config: The config of this Gear
+        :type config: GearConfig
         """
 
         self._config = config
@@ -252,7 +281,7 @@ class Gear(object):
         """Gets the custom of this Gear.
 
 
-        :return: The custom of this Gear.
+        :return: The custom of this Gear
         :rtype: GearCustom
         """
         return self._custom
@@ -262,8 +291,8 @@ class Gear(object):
         """Sets the custom of this Gear.
 
 
-        :param custom: The custom of this Gear.  # noqa: E501
-        :type: GearCustom
+        :param custom: The custom of this Gear
+        :type custom: GearCustom
         """
 
         self._custom = custom
@@ -274,7 +303,7 @@ class Gear(object):
 
         A brief description of the gear's purpose. Ideally 1-4 sentences.
 
-        :return: The description of this Gear.
+        :return: The description of this Gear
         :rtype: str
         """
         return self._description
@@ -285,8 +314,8 @@ class Gear(object):
 
         A brief description of the gear's purpose. Ideally 1-4 sentences.
 
-        :param description: The description of this Gear.  # noqa: E501
-        :type: str
+        :param description: The description of this Gear
+        :type description: str
         """
 
         self._description = description
@@ -296,7 +325,7 @@ class Gear(object):
         """Gets the environment of this Gear.
 
 
-        :return: The environment of this Gear.
+        :return: The environment of this Gear
         :rtype: GearEnvironment
         """
         return self._environment
@@ -306,8 +335,8 @@ class Gear(object):
         """Sets the environment of this Gear.
 
 
-        :param environment: The environment of this Gear.  # noqa: E501
-        :type: GearEnvironment
+        :param environment: The environment of this Gear
+        :type environment: GearEnvironment
         """
 
         self._environment = environment
@@ -317,7 +346,7 @@ class Gear(object):
         """Gets the flywheel of this Gear.
 
 
-        :return: The flywheel of this Gear.
+        :return: The flywheel of this Gear
         :rtype: object
         """
         return self._flywheel
@@ -327,8 +356,8 @@ class Gear(object):
         """Sets the flywheel of this Gear.
 
 
-        :param flywheel: The flywheel of this Gear.  # noqa: E501
-        :type: object
+        :param flywheel: The flywheel of this Gear
+        :type flywheel: object
         """
 
         self._flywheel = flywheel
@@ -339,7 +368,7 @@ class Gear(object):
 
         If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec.
 
-        :return: The command of this Gear.
+        :return: The command of this Gear
         :rtype: str
         """
         return self._command
@@ -350,8 +379,8 @@ class Gear(object):
 
         If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec.
 
-        :param command: The command of this Gear.  # noqa: E501
-        :type: str
+        :param command: The command of this Gear
+        :type command: str
         """
 
         self._command = command
@@ -361,7 +390,7 @@ class Gear(object):
         """Gets the inputs of this Gear.
 
 
-        :return: The inputs of this Gear.
+        :return: The inputs of this Gear
         :rtype: GearInputs
         """
         return self._inputs
@@ -371,8 +400,8 @@ class Gear(object):
         """Sets the inputs of this Gear.
 
 
-        :param inputs: The inputs of this Gear.  # noqa: E501
-        :type: GearInputs
+        :param inputs: The inputs of this Gear
+        :type inputs: GearInputs
         """
 
         self._inputs = inputs
@@ -383,7 +412,7 @@ class Gear(object):
 
         The human-friendly name of this gear.
 
-        :return: The label of this Gear.
+        :return: The label of this Gear
         :rtype: str
         """
         return self._label
@@ -394,8 +423,8 @@ class Gear(object):
 
         The human-friendly name of this gear.
 
-        :param label: The label of this Gear.  # noqa: E501
-        :type: str
+        :param label: The label of this Gear
+        :type label: str
         """
 
         self._label = label
@@ -406,7 +435,7 @@ class Gear(object):
 
         Software license of the gear
 
-        :return: The license of this Gear.
+        :return: The license of this Gear
         :rtype: str
         """
         return self._license
@@ -417,8 +446,8 @@ class Gear(object):
 
         Software license of the gear
 
-        :param license: The license of this Gear.  # noqa: E501
-        :type: str
+        :param license: The license of this Gear
+        :type license: str
         """
 
         self._license = license
@@ -429,7 +458,7 @@ class Gear(object):
 
         The identification of this gear.
 
-        :return: The name of this Gear.
+        :return: The name of this Gear
         :rtype: str
         """
         return self._name
@@ -440,8 +469,8 @@ class Gear(object):
 
         The identification of this gear.
 
-        :param name: The name of this Gear.  # noqa: E501
-        :type: str
+        :param name: The name of this Gear
+        :type name: str
         """
 
         self._name = name
@@ -452,7 +481,7 @@ class Gear(object):
 
         A valid URI, or empty string.
 
-        :return: The source of this Gear.
+        :return: The source of this Gear
         :rtype: str
         """
         return self._source
@@ -463,8 +492,8 @@ class Gear(object):
 
         A valid URI, or empty string.
 
-        :param source: The source of this Gear.  # noqa: E501
-        :type: str
+        :param source: The source of this Gear
+        :type source: str
         """
 
         self._source = source
@@ -475,7 +504,7 @@ class Gear(object):
 
         A valid URI, or empty string.
 
-        :return: The url of this Gear.
+        :return: The url of this Gear
         :rtype: str
         """
         return self._url
@@ -486,8 +515,8 @@ class Gear(object):
 
         A valid URI, or empty string.
 
-        :param url: The url of this Gear.  # noqa: E501
-        :type: str
+        :param url: The url of this Gear
+        :type url: str
         """
 
         self._url = url
@@ -498,7 +527,7 @@ class Gear(object):
 
         A human-friendly string explaining the release version of this gear. Example: 3.2.1
 
-        :return: The version of this Gear.
+        :return: The version of this Gear
         :rtype: str
         """
         return self._version
@@ -509,8 +538,8 @@ class Gear(object):
 
         A human-friendly string explaining the release version of this gear. Example: 3.2.1
 
-        :param version: The version of this Gear.  # noqa: E501
-        :type: str
+        :param version: The version of this Gear
+        :type version: str
         """
 
         self._version = version

flywheel/models/gear_category.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/gear_config.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -34,7 +27,9 @@ class GearConfig(object):
     }
 
     def __init__(self):  # noqa: E501
-        """GearConfig - a model defined in Swagger"""
+        """GearConfig - a model defined in Swagger
+
+        """
         super(GearConfig, self).__init__()
         self.discriminator = None
         self.alt_discriminator = None

flywheel/models/gear_context_input.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -34,7 +27,11 @@ class GearContextInput(object):
     }
 
     def __init__(self, base='context'):  # noqa: E501
-        """GearContextInput - a model defined in Swagger"""
+        """GearContextInput - a model defined in Swagger
+
+        :param base:, defaults to 'context'
+        :type base: str, optional
+        """
         super(GearContextInput, self).__init__()
 
         self._base = None
@@ -49,7 +46,7 @@ class GearContextInput(object):
         """Gets the base of this GearContextInput.
 
 
-        :return: The base of this GearContextInput.
+        :return: The base of this GearContextInput
         :rtype: str
         """
         return self._base
@@ -59,8 +56,8 @@ class GearContextInput(object):
         """Sets the base of this GearContextInput.
 
 
-        :param base: The base of this GearContextInput.  # noqa: E501
-        :type: str
+        :param base: The base of this GearContextInput
+        :type base: str
         """
 
         self._base = base

flywheel/models/gear_context_lookup.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/gear_context_lookup_item.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 

flywheel/models/gear_context_value_output.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -49,7 +42,19 @@ class GearContextValueOutput(object):
     }
 
     def __init__(self, container_type=None, label=None, id=None, value=None, found=False):  # noqa: E501
-        """GearContextValueOutput - a model defined in Swagger"""
+        """GearContextValueOutput - a model defined in Swagger
+
+        :param container_type:, defaults to None
+        :type container_type: ContainerType, optional
+        :param label:, defaults to None
+        :type label: str, optional
+        :param id:, defaults to None
+        :type id: str, optional
+        :param value:, defaults to None
+        :type value: object, optional
+        :param found:, defaults to False
+        :type found: bool, optional
+        """
         super(GearContextValueOutput, self).__init__()
 
         self._container_type = None
@@ -73,7 +78,7 @@ class GearContextValueOutput(object):
         """Gets the container_type of this GearContextValueOutput.
 
 
-        :return: The container_type of this GearContextValueOutput.
+        :return: The container_type of this GearContextValueOutput
         :rtype: ContainerType
         """
         return self._container_type
@@ -83,8 +88,8 @@ class GearContextValueOutput(object):
         """Sets the container_type of this GearContextValueOutput.
 
 
-        :param container_type: The container_type of this GearContextValueOutput.  # noqa: E501
-        :type: ContainerType
+        :param container_type: The container_type of this GearContextValueOutput
+        :type container_type: ContainerType
         """
 
         self._container_type = container_type
@@ -94,7 +99,7 @@ class GearContextValueOutput(object):
         """Gets the label of this GearContextValueOutput.
 
 
-        :return: The label of this GearContextValueOutput.
+        :return: The label of this GearContextValueOutput
         :rtype: str
         """
         return self._label
@@ -104,8 +109,8 @@ class GearContextValueOutput(object):
         """Sets the label of this GearContextValueOutput.
 
 
-        :param label: The label of this GearContextValueOutput.  # noqa: E501
-        :type: str
+        :param label: The label of this GearContextValueOutput
+        :type label: str
         """
 
         self._label = label
@@ -115,7 +120,7 @@ class GearContextValueOutput(object):
         """Gets the id of this GearContextValueOutput.
 
 
-        :return: The id of this GearContextValueOutput.
+        :return: The id of this GearContextValueOutput
         :rtype: str
         """
         return self._id
@@ -125,8 +130,8 @@ class GearContextValueOutput(object):
         """Sets the id of this GearContextValueOutput.
 
 
-        :param id: The id of this GearContextValueOutput.  # noqa: E501
-        :type: str
+        :param id: The id of this GearContextValueOutput
+        :type id: str
         """
 
         self._id = id
@@ -136,7 +141,7 @@ class GearContextValueOutput(object):
         """Gets the value of this GearContextValueOutput.
 
 
-        :return: The value of this GearContextValueOutput.
+        :return: The value of this GearContextValueOutput
         :rtype: object
         """
         return self._value
@@ -146,8 +151,8 @@ class GearContextValueOutput(object):
         """Sets the value of this GearContextValueOutput.
 
 
-        :param value: The value of this GearContextValueOutput.  # noqa: E501
-        :type: object
+        :param value: The value of this GearContextValueOutput
+        :type value: object
         """
 
         self._value = value
@@ -157,7 +162,7 @@ class GearContextValueOutput(object):
         """Gets the found of this GearContextValueOutput.
 
 
-        :return: The found of this GearContextValueOutput.
+        :return: The found of this GearContextValueOutput
         :rtype: bool
         """
         return self._found
@@ -167,8 +172,8 @@ class GearContextValueOutput(object):
         """Sets the found of this GearContextValueOutput.
 
 
-        :param found: The found of this GearContextValueOutput.  # noqa: E501
-        :type: bool
+        :param found: The found of this GearContextValueOutput
+        :type found: bool
         """
 
         self._found = found

flywheel/models/gear_context_value_output_unfound.py

@@ -1,13 +1,6 @@
 # coding: utf-8
 
 """
-    Flywheel
-
-    No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)  # noqa: E501
-
-    OpenAPI spec version: 0.0.1
-    
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
 
 
@@ -34,7 +27,11 @@ class GearContextValueOutputUnfound(object):
     }
 
     def __init__(self, found=False):  # noqa: E501
-        """GearContextValueOutputUnfound - a model defined in Swagger"""
+        """GearContextValueOutputUnfound - a model defined in Swagger
+
+        :param found:, defaults to False
+        :type found: bool, optional
+        """
         super(GearContextValueOutputUnfound, self).__init__()
 
         self._found = None
@@ -49,7 +46,7 @@ class GearContextValueOutputUnfound(object):
         """Gets the found of this GearContextValueOutputUnfound.
 
 
-        :return: The found of this GearContextValueOutputUnfound.
+        :return: The found of this GearContextValueOutputUnfound
         :rtype: bool
         """
         return self._found
@@ -59,8 +56,8 @@ class GearContextValueOutputUnfound(object):
         """Sets the found of this GearContextValueOutputUnfound.
 
 
-        :param found: The found of this GearContextValueOutputUnfound.  # noqa: E501
-        :type: bool
+        :param found: The found of this GearContextValueOutputUnfound
+        :type found: bool
         """
 
         self._found = found