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

flywheel/api/jobs_api.py

@@ -30,11 +30,9 @@ class JobsApi(object):
         Add a job
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: InputJob
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param InputJob body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -58,11 +56,9 @@ class JobsApi(object):
         Add a job
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: InputJob
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param InputJob body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
 
         all_params = ['body',]  # noqa: E501
@@ -141,13 +137,10 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: list[JobLog]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param list[JobLog] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -170,13 +163,10 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: list[JobLog]
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param list[JobLog] body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['job_id','body',]  # noqa: E501
@@ -255,11 +245,9 @@ class JobsApi(object):
         Ask the queue a question, receiving work or statistics in return.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: JobAsk
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobAskResponse
+        :param JobAsk body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobAskResponse
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -283,11 +271,9 @@ class JobsApi(object):
         Ask the queue a question, receiving work or statistics in return.
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: JobAsk
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobAskResponse
+        :param JobAsk body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobAskResponse
         """
 
         all_params = ['body',]  # noqa: E501
@@ -367,13 +353,10 @@ class JobsApi(object):
         Ask the queue for the number of jobs for a given state and query.
         This method makes a synchronous HTTP request by default.
 
-        :param job_state:
-        :type job_state: JobState
-        :param body:
-        :type body: JobAsk
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobAskStateResponse
+        :param JobState job_state: (required)
+        :param JobAsk body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobAskStateResponse
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -397,13 +380,10 @@ class JobsApi(object):
         Ask the queue for the number of jobs for a given state and query.
         This method makes a synchronous HTTP request by default.
 
-        :param job_state:
-        :type job_state: JobState
-        :param body:
-        :type body: JobAsk
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobAskStateResponse
+        :param JobState job_state: (required)
+        :param JobAsk body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobAskStateResponse
         """
 
         all_params = ['job_state','body',]  # noqa: E501
@@ -488,15 +468,11 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobComplete
-        :param job_ticket_id: ticket id for job completion
-        :type job_ticket_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -519,15 +495,11 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobComplete
-        :param job_ticket_id: ticket id for job completion
-        :type job_ticket_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['job_id','body','job_ticket_id',]  # noqa: E501
@@ -614,11 +586,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: InputJob
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Provider
+        :param InputJob body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Provider
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -641,11 +611,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: InputJob
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Provider
+        :param InputJob body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Provider
         """
 
         all_params = ['body',]  # noqa: E501
@@ -724,15 +692,11 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobComplete
-        :param job_ticket_id: ticket id for job completion
-        :type job_ticket_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -755,15 +719,11 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobComplete
-        :param job_ticket_id: ticket id for job completion
-        :type job_ticket_id: str, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: None
+        :param str job_id: (required)
+        :param JobComplete body: (required)
+        :param str job_ticket_id: ticket id for job completion
+        :param bool async_: Perform the request asynchronously
+        :return: None
         """
 
         all_params = ['job_id','body','job_ticket_id',]  # noqa: E501
@@ -850,11 +810,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobTicketOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -877,11 +835,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobTicketOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -949,27 +905,17 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param include_parent_info: Include the parent info for the jobs, defaults to false
-        :type include_parent_info: bool, optional
-        :param include_all_info: Include all info in returned objects, defaults to false
-        :type include_all_info: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[JobListOutput],Page]
+        :param bool include_parent_info: Include the parent info for the jobs
+        :param bool include_all_info: Include all info in returned objects
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[JobListOutput],Page]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -992,27 +938,17 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param include_parent_info: Include the parent info for the jobs, defaults to false
-        :type include_parent_info: bool, optional
-        :param include_all_info: Include all info in returned objects, defaults to false
-        :type include_all_info: bool, optional
-        :param filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
-        :type filter: str, optional
-        :param sort: The sort fields and order. (e.g. label:asc,created:desc)
-        :type sort: str, optional
-        :param limit: The maximum number of entries to return.
-        :type limit: int, optional
-        :param skip: The number of entries to skip., defaults to 0
-        :type skip: int, optional
-        :param page: The page number (i.e. skip limit*page entries)
-        :type page: int, optional
-        :param after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
-        :type after_id: str, optional
-        :param x_accept_feature:, defaults to []
-        :type x_accept_feature: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: union[list[JobListOutput],Page]
+        :param bool include_parent_info: Include the parent info for the jobs
+        :param bool include_all_info: Include all info in returned objects
+        :param str filter: Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\\'. (e.g. label=my-label,created>2018-09-22)
+        :param str sort: The sort fields and order. (e.g. label:asc,created:desc)
+        :param int limit: The maximum number of entries to return.
+        :param int skip: The number of entries to skip.
+        :param int page: The page number (i.e. skip limit*page entries)
+        :param str after_id: Paginate after the given id. (Cannot be used with sort, page or skip)
+        :param list[str] x_accept_feature:
+        :param bool async_: Perform the request asynchronously
+        :return: union[list[JobListOutput],Page]
         """
 
         all_params = ['include_parent_info','include_all_info','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -1093,11 +1029,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1120,11 +1054,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobOutput
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -1192,11 +1124,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobOutputConfig
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobOutputConfig
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1219,11 +1149,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobOutputConfig
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobOutputConfig
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -1291,11 +1219,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobDetail
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobDetail
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1318,11 +1244,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobDetail
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobDetail
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -1390,11 +1314,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobLogRecord
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobLogRecord
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1417,11 +1339,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobLogRecord
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobLogRecord
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -1489,9 +1409,8 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1514,9 +1433,8 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: object
+        :param bool async_: Perform the request asynchronously
+        :return: object
         """
 
         all_params = []  # noqa: E501
@@ -1579,13 +1497,10 @@ class JobsApi(object):
         Used by the engine.
         This method makes a synchronous HTTP request by default.
 
-        :param tags:
-        :type tags: list[str], optional
-        :param tags:
-        :type tags: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Job
+        :param list[str] tags:
+        :param list[str] tags:
+        :param bool async_: Perform the request asynchronously
+        :return: Job
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1609,13 +1524,10 @@ class JobsApi(object):
         Used by the engine.
         This method makes a synchronous HTTP request by default.
 
-        :param tags:
-        :type tags: list[str], optional
-        :param tags:
-        :type tags: list[str], optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: Job
+        :param list[str] tags:
+        :param list[str] tags:
+        :param bool async_: Perform the request asynchronously
+        :return: Job
         """
 
         all_params = ['tags','tags',]  # noqa: E501
@@ -1684,11 +1596,9 @@ class JobsApi(object):
         Updates the modified timestamp for a running job without changing its state. Used by engines to keep jobs alive.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1712,11 +1622,9 @@ class JobsApi(object):
         Updates the modified timestamp for a running job without changing its state. Used by engines to keep jobs alive.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -1785,13 +1693,10 @@ class JobsApi(object):
         Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in 'pending' or 'running' state. Accepts the same body as /api/jobs/add, except all fields are optional.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param JobModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1815,13 +1720,10 @@ class JobsApi(object):
         Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in 'pending' or 'running' state. Accepts the same body as /api/jobs/add, except all fields are optional.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: JobModify
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param JobModify body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
 
         all_params = ['job_id','body',]  # noqa: E501
@@ -1906,11 +1808,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobTicketOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -1933,11 +1833,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: JobTicketOutput
+        :param str job_id: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: JobTicketOutput
         """
 
         all_params = ['job_id',]  # noqa: E501
@@ -2005,9 +1903,8 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: OrphanedCount
+        :param bool async_: Perform the request asynchronously
+        :return: OrphanedCount
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -2030,9 +1927,8 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: OrphanedCount
+        :param bool async_: Perform the request asynchronously
+        :return: OrphanedCount
         """
 
         all_params = []  # noqa: E501
@@ -2095,15 +1991,11 @@ class JobsApi(object):
         The job must have a state of 'failed', and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param compute_provider_id:
-        :type compute_provider_id: str, optional
-        :param ignore_state:, defaults to false
-        :type ignore_state: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param str job_id: (required)
+        :param str compute_provider_id:
+        :param bool ignore_state:
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -2127,15 +2019,11 @@ class JobsApi(object):
         The job must have a state of 'failed', and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned.
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param compute_provider_id:
-        :type compute_provider_id: str, optional
-        :param ignore_state:, defaults to false
-        :type ignore_state: bool, optional
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: InsertedId
+        :param str job_id: (required)
+        :param str compute_provider_id:
+        :param bool ignore_state:
+        :param bool async_: Perform the request asynchronously
+        :return: InsertedId
         """
 
         all_params = ['job_id','compute_provider_id','ignore_state',]  # noqa: E501
@@ -2208,13 +2096,10 @@ class JobsApi(object):
         Update profile information on a job. (e.g. machine type, etc)
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: InputJobProfile
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param InputJobProfile body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -2238,13 +2123,10 @@ class JobsApi(object):
         Update profile information on a job. (e.g. machine type, etc)
         This method makes a synchronous HTTP request by default.
 
-        :param job_id:
-        :type job_id: str
-        :param body:
-        :type body: InputJobProfile
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param str job_id: (required)
+        :param InputJobProfile body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
 
         all_params = ['job_id','body',]  # noqa: E501
@@ -2329,11 +2211,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: JobPriorityUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param JobPriorityUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -2356,11 +2236,9 @@ class JobsApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param body:
-        :type body: JobPriorityUpdate
-        :param async_: Perform the request asynchronously
-        :type async_: bool, optional
-        :rtype: ModifiedResult
+        :param JobPriorityUpdate body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: ModifiedResult
         """
 
         all_params = ['body',]  # noqa: E501