Sybren A. Stüvel c439bc3a1e OAPI: regenerate code

2022-10-20 13:13:22 +02:00

36 KiB

Raw Blame History

flamenco.manager.JobsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
fetch_global_last_rendered_info	GET /api/v3/jobs/last-rendered	Get the URL that serves the last-rendered images.
fetch_job	GET /api/v3/jobs/{job_id}	Fetch info about the job.
fetch_job_blocklist	GET /api/v3/jobs/{job_id}/blocklist	Fetch the list of workers that are blocked from doing certain task types on this job.
fetch_job_last_rendered_info	GET /api/v3/jobs/{job_id}/last-rendered	Get the URL that serves the last-rendered images of this job.
fetch_job_tasks	GET /api/v3/jobs/{job_id}/tasks	Fetch a summary of all tasks of the given job.
fetch_task	GET /api/v3/tasks/{task_id}	Fetch a single task.
fetch_task_log_info	GET /api/v3/tasks/{task_id}/log	Get the URL of the task log, and some more info.
fetch_task_log_tail	GET /api/v3/tasks/{task_id}/logtail	Fetch the last few lines of the task's log.
get_job_type	GET /api/v3/jobs/type/{typeName}	Get single job type and its parameters.
get_job_types	GET /api/v3/jobs/types	Get list of job types and their parameters.
query_jobs	POST /api/v3/jobs/query	Fetch list of jobs.
remove_job_blocklist	DELETE /api/v3/jobs/{job_id}/blocklist	Remove entries from a job blocklist.
set_job_priority	POST /api/v3/jobs/{job_id}/setpriority
set_job_status	POST /api/v3/jobs/{job_id}/setstatus
set_task_status	POST /api/v3/tasks/{task_id}/setstatus
submit_job	POST /api/v3/jobs	Submit a new job for Flamenco Manager to execute.
submit_job_check	POST /api/v3/jobs/check	Submit a new job for Flamenco Manager to check.

fetch_global_last_rendered_info

JobLastRenderedImageInfo fetch_global_last_rendered_info()

Get the URL that serves the last-rendered images.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.job_last_rendered_image_info import JobLastRenderedImageInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get the URL that serves the last-rendered images.
        api_response = api_instance.fetch_global_last_rendered_info()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_global_last_rendered_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

JobLastRenderedImageInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response.	-
204	This job doesn't have any last-rendered image.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_job

Job fetch_job(job_id)

Fetch info about the job.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.job import Job
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Fetch info about the job.
        api_response = api_instance.fetch_job(job_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_job: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str

Return type

Job

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Job info	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_job_blocklist

JobBlocklist fetch_job_blocklist(job_id)

Fetch the list of workers that are blocked from doing certain task types on this job.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.job_blocklist import JobBlocklist
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Fetch the list of workers that are blocked from doing certain task types on this job.
        api_response = api_instance.fetch_job_blocklist(job_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_job_blocklist: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str

Return type

JobBlocklist

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get tuples (worker, task type) that got blocked on this job.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_job_last_rendered_info

JobLastRenderedImageInfo fetch_job_last_rendered_info(job_id)

Get the URL that serves the last-rendered images of this job.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.job_last_rendered_image_info import JobLastRenderedImageInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the URL that serves the last-rendered images of this job.
        api_response = api_instance.fetch_job_last_rendered_info(job_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_job_last_rendered_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str

Return type

JobLastRenderedImageInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal response.	-
204	This job doesn't have any last-rendered image.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_job_tasks

JobTasksSummary fetch_job_tasks(job_id)

Fetch a summary of all tasks of the given job.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.job_tasks_summary import JobTasksSummary
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Fetch a summary of all tasks of the given job.
        api_response = api_instance.fetch_job_tasks(job_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_job_tasks: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str

Return type

JobTasksSummary

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Get summaries of the tasks of this job.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_task

Task fetch_task(task_id)

Fetch a single task.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.task import Task
from flamenco.manager.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    task_id = "task_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Fetch a single task.
        api_response = api_instance.fetch_task(task_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_task: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str

Return type

Task

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The task info.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_task_log_info

TaskLogInfo fetch_task_log_info(task_id)

Get the URL of the task log, and some more info.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.task_log_info import TaskLogInfo
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    task_id = "task_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get the URL of the task log, and some more info.
        api_response = api_instance.fetch_task_log_info(task_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_task_log_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str

Return type

TaskLogInfo

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The task log info.	-
204	Returned when the task has no log yet.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_task_log_tail

str fetch_task_log_tail(task_id)

Fetch the last few lines of the task's log.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    task_id = "task_id_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Fetch the last few lines of the task's log.
        api_response = api_instance.fetch_task_log_tail(task_id)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->fetch_task_log_tail: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

HTTP response details

Status code	Description	Response headers
200	The task log.	-
204	Returned when the task has no log yet.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_job_type

AvailableJobType get_job_type(type_name)

Get single job type and its parameters.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.available_job_type import AvailableJobType
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    type_name = "typeName_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # Get single job type and its parameters.
        api_response = api_instance.get_job_type(type_name)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->get_job_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
type_name	str

Return type

AvailableJobType

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Job type	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_job_types

AvailableJobTypes get_job_types()

Get list of job types and their parameters.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.available_job_types import AvailableJobTypes
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get list of job types and their parameters.
        api_response = api_instance.get_job_types()
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->get_job_types: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

AvailableJobTypes

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Available job types	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

query_jobs

JobsQueryResult query_jobs(jobs_query)

Fetch list of jobs.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.jobs_query import JobsQuery
from flamenco.manager.model.jobs_query_result import JobsQueryResult
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    jobs_query = JobsQuery(
        offset=0,
        limit=1,
        order_by=[
            "order_by_example",
        ],
        status_in=[
            JobStatus("active"),
        ],
        metadata={
            "key": "key_example",
        },
        settings={},
    ) # JobsQuery | Specification of which jobs to get.

    # example passing only required values which don't have defaults set
    try:
        # Fetch list of jobs.
        api_response = api_instance.query_jobs(jobs_query)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->query_jobs: %s\n" % e)

Parameters

Name	Type	Description	Notes
jobs_query	JobsQuery	Specification of which jobs to get.

Return type

JobsQueryResult

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Normal query response, can be empty list if nothing matched the query.	-
0	Error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

remove_job_blocklist

remove_job_blocklist(job_id)

Remove entries from a job blocklist.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.job_blocklist import JobBlocklist
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 
    job_blocklist = JobBlocklist([
        JobBlocklistEntry(
            worker_id="worker_id_example",
            task_type="task_type_example",
            worker_name="worker_name_example",
        ),
    ]) # JobBlocklist | Tuples (worker, task type) to be removed from the blocklist. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Remove entries from a job blocklist.
        api_instance.remove_job_blocklist(job_id)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->remove_job_blocklist: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Remove entries from a job blocklist.
        api_instance.remove_job_blocklist(job_id, job_blocklist=job_blocklist)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->remove_job_blocklist: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str
job_blocklist	JobBlocklist	Tuples (worker, task type) to be removed from the blocklist.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Request accepted, entries have been removed.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_job_priority

set_job_priority(job_id, job_priority_change)

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.job_priority_change import JobPriorityChange
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 
    job_priority_change = JobPriorityChange(
        priority=0,
    ) # JobPriorityChange | The new priority.

    # example passing only required values which don't have defaults set
    try:
        api_instance.set_job_priority(job_id, job_priority_change)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->set_job_priority: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str
job_priority_change	JobPriorityChange	The new priority.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Priority change was accepted.	-
422	The requested priority is not acceptable.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_job_status

set_job_status(job_id, job_status_change)

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.error import Error
from flamenco.manager.model.job_status_change import JobStatusChange
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    job_id = "job_id_example" # str | 
    job_status_change = JobStatusChange(
        status=JobStatus("active"),
        reason="reason_example",
    ) # JobStatusChange | The status change to request.

    # example passing only required values which don't have defaults set
    try:
        api_instance.set_job_status(job_id, job_status_change)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->set_job_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str
job_status_change	JobStatusChange	The status change to request.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Status change was accepted.	-
422	The requested status change is not valid for the current status of the job.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_task_status

set_task_status(task_id, task_status_change)

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.task_status_change import TaskStatusChange
from flamenco.manager.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    task_id = "task_id_example" # str | 
    task_status_change = TaskStatusChange(
        status=TaskStatus("active"),
        reason="reason_example",
    ) # TaskStatusChange | The status change to request.

    # example passing only required values which don't have defaults set
    try:
        api_instance.set_task_status(task_id, task_status_change)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->set_task_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
task_id	str
task_status_change	TaskStatusChange	The status change to request.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Status change was accepted.	-
422	The requested status change is not valid for the current status of the task.	-
0	Unexpected error.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submit_job

Job submit_job(submitted_job)

Submit a new job for Flamenco Manager to execute.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.submitted_job import SubmittedJob
from flamenco.manager.model.error import Error
from flamenco.manager.model.job import Job
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    submitted_job = SubmittedJob(
        name="name_example",
        type="type_example",
        type_etag="type_etag_example",
        priority=50,
        settings=JobSettings(),
        metadata=JobMetadata(
            key="key_example",
        ),
        submitter_platform="submitter_platform_example",
    ) # SubmittedJob | Job to submit

    # example passing only required values which don't have defaults set
    try:
        # Submit a new job for Flamenco Manager to execute.
        api_response = api_instance.submit_job(submitted_job)
        pprint(api_response)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->submit_job: %s\n" % e)

Parameters

Name	Type	Description	Notes
submitted_job	SubmittedJob	Job to submit

Return type

Job

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Job was succesfully compiled into individual tasks.	-
412	The given job type etag does not match the job type etag on the Manager. This is likely due to the client caching the job type for too long.	-
0	Error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submit_job_check

submit_job_check(submitted_job)

Submit a new job for Flamenco Manager to check.

Example

import time
import flamenco.manager
from flamenco.manager.api import jobs_api
from flamenco.manager.model.submitted_job import SubmittedJob
from flamenco.manager.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = flamenco.manager.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with flamenco.manager.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    submitted_job = SubmittedJob(
        name="name_example",
        type="type_example",
        type_etag="type_etag_example",
        priority=50,
        settings=JobSettings(),
        metadata=JobMetadata(
            key="key_example",
        ),
        submitter_platform="submitter_platform_example",
    ) # SubmittedJob | Job to check

    # example passing only required values which don't have defaults set
    try:
        # Submit a new job for Flamenco Manager to check.
        api_instance.submit_job_check(submitted_job)
    except flamenco.manager.ApiException as e:
        print("Exception when calling JobsApi->submit_job_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
submitted_job	SubmittedJob	Job to check

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Job was succesfully compiled into individual tasks. The job and tasks have NOT been stored in the database, though.	-
412	The given job type etag does not match the job type etag on the Manager. This is likely due to the client caching the job type for too long.	-
0	Error message	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

36 KiB Raw Blame History

flamenco.manager.JobsApi

fetch_global_last_rendered_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_job

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_job_blocklist

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_job_last_rendered_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_job_tasks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_task

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_task_log_info

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fetch_task_log_tail

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_job_type

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_job_types

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

query_jobs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_job_blocklist

36 KiB

Raw Blame History