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

flywheel/models/gear_document.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_document_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
 """
 
 

flywheel/models/gear_document_legacy_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
 """
 
 

flywheel/models/gear_environment.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_exchange.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_file_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
 """
 
 

flywheel/models/gear_id_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
 """
 
 

flywheel/models/gear_info.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_input_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_inputs.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_key_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
 """
 
 

flywheel/models/gear_manifest.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_mixin.py

@@ -116,7 +116,16 @@ class GearMixin(object):
                 default_config[key] = value.get("default")
         return default_config
 
-    def run(self, config=None, analysis_label=None, tags=None, destination=None, inputs=None, priority=None, **kwargs):
+    def run(
+        self,
+        config=None,
+        analysis_label=None,
+        tags=None,
+        destination=None,
+        inputs=None,
+        priority=None,
+        **kwargs,
+    ):
         """Run the gear.
 
         :param dict config: The configuration to use, if overriding defaults.
@@ -124,6 +133,7 @@ class GearMixin(object):
         :param list tags: The list of tags to set for the job.
         :param object destination: The destination container.
         :param dict inputs: The list of input containers or files.
+        :param str priority: The priority for the gear run.
 
         :return: The id of the job that was created (utility gear) or of the analysis container created (analysis gear).
         """
@@ -186,15 +196,26 @@ class GearMixin(object):
         return self._invoke_gear_api("get_gear_series")
 
     def add_permission(self, permission_type, permission_id):
-        """Add individual permission to gear."""
+        """Add an individual permission to gear.
+
+        :param GearPermissionsType permisson_type: The type of permission to add.
+        :param str permission_id: The permission ID to add.
+        """
         return self._invoke_gear_api("add_gear_permission", permission_type, permission_id)
 
     def replace_permissions(self, permissions):
-        """Replace gear permissions."""
+        """Replace the existing gear permissions.
+
+        :param GearPermissions permissions: The new permissions to set for the gear.
+        """
         return self._invoke_gear_api("replace_gear_permissions", permissions)
 
     def delete_permission(self, permission_type, permission_id):
-        """Delete individual permission by type and id"""
+        """Delete an individual permission by type and id.
+
+        :param GearPermissionsType permisson_type: The type of permission to delete.
+        :param str permission_id: The permission ID to delete.
+        """
         self._invoke_gear_api("delete_gear_permission", permission_type, permission_id)
 
     def delete_all_permissions(self):
@@ -205,8 +226,7 @@ class GearMixin(object):
         self._invoke_gear_api("delete_gear_permissions")
 
     def modify_gear_series(self, gear_series_update):
-        """
-        Modify the gear series attributes such as `is_restricted`
+        """Modify the gear series attributes such as `is_restricted`.
 
         :param GearSeriesUpdate gear_series_update: the dictionary specifying
             the updates to make to the gear series

flywheel/models/gear_node.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_output_configuration.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_permissions.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_permissions_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
 """
 
 

flywheel/models/gear_permissions_type.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_return_ticket.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_rule.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
 """
 
 
@@ -46,7 +39,8 @@ class GearRule(object):
         'disabled': 'bool',
         'compute_provider_id': 'str',
         'last_modified_by': 'Origin',
-        'triggering_input': 'str'
+        'triggering_input': 'str',
+        'tags': 'list[str]'
     }
 
     attribute_map = {
@@ -68,7 +62,8 @@ class GearRule(object):
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
         'last_modified_by': 'last_modified_by',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
     rattribute_map = {
@@ -90,10 +85,11 @@ class GearRule(object):
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
         'last_modified_by': 'last_modified_by',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
-    def __init__(self, id=None, project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, revision=1, any=None, all=None, _not=None, created=None, modified=None, disabled=False, compute_provider_id=None, last_modified_by=None, triggering_input=None):  # noqa: E501
+    def __init__(self, id=None, project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, revision=1, any=None, all=None, _not=None, created=None, modified=None, disabled=False, compute_provider_id=None, last_modified_by=None, triggering_input=None, tags=None):  # noqa: E501
         """GearRule - a model defined in Swagger"""
         super(GearRule, self).__init__()
 
@@ -116,6 +112,7 @@ class GearRule(object):
         self._compute_provider_id = None
         self._last_modified_by = None
         self._triggering_input = None
+        self._tags = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -154,6 +151,8 @@ class GearRule(object):
             self.last_modified_by = last_modified_by
         if triggering_input is not None:
             self.triggering_input = triggering_input
+        if tags is not None:
+            self.tags = tags
 
     @property
     def id(self):
@@ -554,6 +553,29 @@ class GearRule(object):
 
         self._triggering_input = triggering_input
 
+    @property
+    def tags(self):
+        """Gets the tags of this GearRule.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :return: The tags of this GearRule.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this GearRule.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :param tags: The tags of this GearRule.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
 
     @staticmethod
     def positional_to_model(value):

flywheel/models/gear_rule_condition.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_rule_condition_type.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_rule_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
 """
 
 
@@ -39,7 +32,8 @@ class GearRuleInput(object):
         '_not': 'list[GearRuleCondition]',
         'disabled': 'bool',
         'compute_provider_id': 'str',
-        'triggering_input': 'str'
+        'triggering_input': 'str',
+        'tags': 'list[str]'
     }
 
     attribute_map = {
@@ -56,7 +50,8 @@ class GearRuleInput(object):
         '_not': 'not',
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
     rattribute_map = {
@@ -73,10 +68,11 @@ class GearRuleInput(object):
         'not': '_not',
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
-    def __init__(self, project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, any=None, all=None, _not=None, disabled=False, compute_provider_id=None, triggering_input=None):  # noqa: E501
+    def __init__(self, project_id=None, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=False, any=None, all=None, _not=None, disabled=False, compute_provider_id=None, triggering_input=None, tags=None):  # noqa: E501
         """GearRuleInput - a model defined in Swagger"""
         super(GearRuleInput, self).__init__()
 
@@ -94,6 +90,7 @@ class GearRuleInput(object):
         self._disabled = None
         self._compute_provider_id = None
         self._triggering_input = None
+        self._tags = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -123,6 +120,8 @@ class GearRuleInput(object):
             self.compute_provider_id = compute_provider_id
         if triggering_input is not None:
             self.triggering_input = triggering_input
+        if tags is not None:
+            self.tags = tags
 
     @property
     def project_id(self):
@@ -418,6 +417,29 @@ class GearRuleInput(object):
 
         self._triggering_input = triggering_input
 
+    @property
+    def tags(self):
+        """Gets the tags of this GearRuleInput.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :return: The tags of this GearRuleInput.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this GearRuleInput.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :param tags: The tags of this GearRuleInput.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
 
     @staticmethod
     def positional_to_model(value):

flywheel/models/gear_rule_modify_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
 """
 
 
@@ -38,7 +31,8 @@ class GearRuleModifyInput(object):
         '_not': 'list[GearRuleCondition]',
         'disabled': 'bool',
         'compute_provider_id': 'str',
-        'triggering_input': 'str'
+        'triggering_input': 'str',
+        'tags': 'list[str]'
     }
 
     attribute_map = {
@@ -54,7 +48,8 @@ class GearRuleModifyInput(object):
         '_not': 'not',
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
     rattribute_map = {
@@ -70,10 +65,11 @@ class GearRuleModifyInput(object):
         'not': '_not',
         'disabled': 'disabled',
         'compute_provider_id': 'compute_provider_id',
-        'triggering_input': 'triggering_input'
+        'triggering_input': 'triggering_input',
+        'tags': 'tags'
     }
 
-    def __init__(self, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=None, any=None, all=None, _not=None, disabled=None, compute_provider_id=None, triggering_input=None):  # noqa: E501
+    def __init__(self, gear_id=None, role_id=None, name=None, config=None, fixed_inputs=None, priority=None, auto_update=None, any=None, all=None, _not=None, disabled=None, compute_provider_id=None, triggering_input=None, tags=None):  # noqa: E501
         """GearRuleModifyInput - a model defined in Swagger"""
         super(GearRuleModifyInput, self).__init__()
 
@@ -90,6 +86,7 @@ class GearRuleModifyInput(object):
         self._disabled = None
         self._compute_provider_id = None
         self._triggering_input = None
+        self._tags = None
         self.discriminator = None
         self.alt_discriminator = None
 
@@ -119,6 +116,8 @@ class GearRuleModifyInput(object):
             self.compute_provider_id = compute_provider_id
         if triggering_input is not None:
             self.triggering_input = triggering_input
+        if tags is not None:
+            self.tags = tags
 
     @property
     def gear_id(self):
@@ -393,6 +392,29 @@ class GearRuleModifyInput(object):
 
         self._triggering_input = triggering_input
 
+    @property
+    def tags(self):
+        """Gets the tags of this GearRuleModifyInput.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :return: The tags of this GearRuleModifyInput.
+        :rtype: list[str]
+        """
+        return self._tags
+
+    @tags.setter
+    def tags(self, tags):
+        """Sets the tags of this GearRuleModifyInput.
+
+        Tags to be applied to jobs created when this gear rule triggers
+
+        :param tags: The tags of this GearRuleModifyInput.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._tags = tags
+
 
     @staticmethod
     def positional_to_model(value):