1188 lines
42 KiB
Python
1188 lines
42 KiB
Python
"""
|
|
Flamenco manager
|
|
|
|
Render Farm manager API # noqa: E501
|
|
|
|
The version of the OpenAPI document: 1.0.0
|
|
Generated by: https://openapi-generator.tech
|
|
"""
|
|
|
|
|
|
import re # noqa: F401
|
|
import sys # noqa: F401
|
|
|
|
from flamenco.manager.api_client import ApiClient, Endpoint as _Endpoint
|
|
from flamenco.manager.model_utils import ( # noqa: F401
|
|
check_allowed_values,
|
|
check_validations,
|
|
date,
|
|
datetime,
|
|
file_type,
|
|
none_type,
|
|
validate_and_convert_types
|
|
)
|
|
from flamenco.manager.model.assigned_task import AssignedTask
|
|
from flamenco.manager.model.error import Error
|
|
from flamenco.manager.model.may_keep_running import MayKeepRunning
|
|
from flamenco.manager.model.registered_worker import RegisteredWorker
|
|
from flamenco.manager.model.security_error import SecurityError
|
|
from flamenco.manager.model.task_update import TaskUpdate
|
|
from flamenco.manager.model.worker_registration import WorkerRegistration
|
|
from flamenco.manager.model.worker_sign_on import WorkerSignOn
|
|
from flamenco.manager.model.worker_state_change import WorkerStateChange
|
|
from flamenco.manager.model.worker_state_changed import WorkerStateChanged
|
|
|
|
|
|
class WorkerApi(object):
|
|
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
Ref: https://openapi-generator.tech
|
|
|
|
Do not edit the class manually.
|
|
"""
|
|
|
|
def __init__(self, api_client=None):
|
|
if api_client is None:
|
|
api_client = ApiClient()
|
|
self.api_client = api_client
|
|
self.may_worker_run_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (MayKeepRunning,),
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/task/{task_id}/may-i-run',
|
|
'operation_id': 'may_worker_run',
|
|
'http_method': 'GET',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'task_id',
|
|
],
|
|
'required': [
|
|
'task_id',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'task_id':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'task_id': 'task_id',
|
|
},
|
|
'location_map': {
|
|
'task_id': 'path',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.register_worker_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (RegisteredWorker,),
|
|
'auth': [],
|
|
'endpoint_path': '/api/v3/worker/register-worker',
|
|
'operation_id': 'register_worker',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'worker_registration',
|
|
],
|
|
'required': [
|
|
'worker_registration',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'worker_registration':
|
|
(WorkerRegistration,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'worker_registration': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.schedule_task_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (AssignedTask,),
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/task',
|
|
'operation_id': 'schedule_task',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
],
|
|
'required': [],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.sign_off_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': None,
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/sign-off',
|
|
'operation_id': 'sign_off',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
],
|
|
'required': [],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.sign_on_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (WorkerStateChange,),
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/sign-on',
|
|
'operation_id': 'sign_on',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'worker_sign_on',
|
|
],
|
|
'required': [
|
|
'worker_sign_on',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'worker_sign_on':
|
|
(WorkerSignOn,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'worker_sign_on': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.task_output_produced_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': None,
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/task/{task_id}/output-produced',
|
|
'operation_id': 'task_output_produced',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'task_id',
|
|
'body',
|
|
],
|
|
'required': [
|
|
'task_id',
|
|
'body',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'task_id':
|
|
(str,),
|
|
'body':
|
|
(file_type,),
|
|
},
|
|
'attribute_map': {
|
|
'task_id': 'task_id',
|
|
},
|
|
'location_map': {
|
|
'task_id': 'path',
|
|
'body': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'image/jpeg',
|
|
'image/png'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.task_update_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': None,
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/task/{task_id}',
|
|
'operation_id': 'task_update',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'task_id',
|
|
'task_update',
|
|
],
|
|
'required': [
|
|
'task_id',
|
|
'task_update',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'task_id':
|
|
(str,),
|
|
'task_update':
|
|
(TaskUpdate,),
|
|
},
|
|
'attribute_map': {
|
|
'task_id': 'task_id',
|
|
},
|
|
'location_map': {
|
|
'task_id': 'path',
|
|
'task_update': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.worker_state_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (WorkerStateChange,),
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/state',
|
|
'operation_id': 'worker_state',
|
|
'http_method': 'GET',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
],
|
|
'required': [],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.worker_state_changed_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': None,
|
|
'auth': [
|
|
'worker_auth'
|
|
],
|
|
'endpoint_path': '/api/v3/worker/state-changed',
|
|
'operation_id': 'worker_state_changed',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'worker_state_changed',
|
|
],
|
|
'required': [
|
|
'worker_state_changed',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'worker_state_changed':
|
|
(WorkerStateChanged,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'worker_state_changed': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
|
|
def may_worker_run(
|
|
self,
|
|
task_id,
|
|
**kwargs
|
|
):
|
|
"""The response indicates whether the worker is allowed to run / keep running the task. Optionally contains a queued worker status change. # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.may_worker_run(task_id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
task_id (str):
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
MayKeepRunning
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['task_id'] = \
|
|
task_id
|
|
return self.may_worker_run_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def register_worker(
|
|
self,
|
|
worker_registration,
|
|
**kwargs
|
|
):
|
|
"""Register a new worker # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.register_worker(worker_registration, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
worker_registration (WorkerRegistration): Worker to register
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
RegisteredWorker
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['worker_registration'] = \
|
|
worker_registration
|
|
return self.register_worker_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def schedule_task(
|
|
self,
|
|
**kwargs
|
|
):
|
|
"""Obtain a new task to execute # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.schedule_task(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
AssignedTask
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
return self.schedule_task_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def sign_off(
|
|
self,
|
|
**kwargs
|
|
):
|
|
"""Mark the worker as offline # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.sign_off(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
None
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
return self.sign_off_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def sign_on(
|
|
self,
|
|
worker_sign_on,
|
|
**kwargs
|
|
):
|
|
"""Authenticate & sign in the worker. # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.sign_on(worker_sign_on, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
worker_sign_on (WorkerSignOn): Worker metadata
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
WorkerStateChange
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['worker_sign_on'] = \
|
|
worker_sign_on
|
|
return self.sign_on_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def task_output_produced(
|
|
self,
|
|
task_id,
|
|
body,
|
|
**kwargs
|
|
):
|
|
"""Store the most recently rendered frame here. Note that it is up to the Worker to ensure this is in a format that's digestable by the Manager. Currently only PNG and JPEG support is planned. # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.task_output_produced(task_id, body, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
task_id (str):
|
|
body (file_type): Contents of the file
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
None
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['task_id'] = \
|
|
task_id
|
|
kwargs['body'] = \
|
|
body
|
|
return self.task_output_produced_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def task_update(
|
|
self,
|
|
task_id,
|
|
task_update,
|
|
**kwargs
|
|
):
|
|
"""Update the task, typically to indicate progress, completion, or failure. # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.task_update(task_id, task_update, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
task_id (str):
|
|
task_update (TaskUpdate): Task update information
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
None
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['task_id'] = \
|
|
task_id
|
|
kwargs['task_update'] = \
|
|
task_update
|
|
return self.task_update_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def worker_state(
|
|
self,
|
|
**kwargs
|
|
):
|
|
"""worker_state # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.worker_state(async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
WorkerStateChange
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
return self.worker_state_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def worker_state_changed(
|
|
self,
|
|
worker_state_changed,
|
|
**kwargs
|
|
):
|
|
"""Worker changed state. This could be as acknowledgement of a Manager-requested state change, or in response to worker-local signals. # noqa: E501
|
|
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.worker_state_changed(worker_state_changed, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
worker_state_changed (WorkerStateChanged): New worker state
|
|
|
|
Keyword Args:
|
|
_return_http_data_only (bool): response data without head status
|
|
code and headers. Default is True.
|
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
will be returned without reading/decoding response data.
|
|
Default is True.
|
|
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
one number provided, it will be total request timeout. It can also
|
|
be a pair (tuple) of (connection, read) timeouts.
|
|
Default is None.
|
|
_check_input_type (bool): specifies if type checking
|
|
should be done one the data sent to the server.
|
|
Default is True.
|
|
_check_return_type (bool): specifies if type checking
|
|
should be done one the data received from the server.
|
|
Default is True.
|
|
_spec_property_naming (bool): True if the variable names in the input data
|
|
are serialized names, as specified in the OpenAPI document.
|
|
False if the variable names in the input data
|
|
are pythonic names, e.g. snake case (default)
|
|
_content_type (str/None): force body content-type.
|
|
Default is None and content-type will be predicted by allowed
|
|
content-types and body.
|
|
_host_index (int/None): specifies the index of the server
|
|
that we want to use.
|
|
Default is read from the configuration.
|
|
async_req (bool): execute request asynchronously
|
|
|
|
Returns:
|
|
None
|
|
If the method is called asynchronously, returns the request
|
|
thread.
|
|
"""
|
|
kwargs['async_req'] = kwargs.get(
|
|
'async_req', False
|
|
)
|
|
kwargs['_return_http_data_only'] = kwargs.get(
|
|
'_return_http_data_only', True
|
|
)
|
|
kwargs['_preload_content'] = kwargs.get(
|
|
'_preload_content', True
|
|
)
|
|
kwargs['_request_timeout'] = kwargs.get(
|
|
'_request_timeout', None
|
|
)
|
|
kwargs['_check_input_type'] = kwargs.get(
|
|
'_check_input_type', True
|
|
)
|
|
kwargs['_check_return_type'] = kwargs.get(
|
|
'_check_return_type', True
|
|
)
|
|
kwargs['_spec_property_naming'] = kwargs.get(
|
|
'_spec_property_naming', False
|
|
)
|
|
kwargs['_content_type'] = kwargs.get(
|
|
'_content_type')
|
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
kwargs['worker_state_changed'] = \
|
|
worker_state_changed
|
|
return self.worker_state_changed_endpoint.call_with_http_info(**kwargs)
|
|
|