Skip to content

libica.openapi.libtes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The libica.openapi.libtes package is automatically generated by the OpenAPI Generator project:

  • API version: v1
  • Package version: 1.0.0
  • Build date: 2024-07-26T11:42:26.405520+10:00[Australia/Melbourne]
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.15
  • six >= 1.10
  • certifi
  • python-dateutil

Getting Started

In your own code, to use this library to connect and interact with libica.openapi.libtes, you can run the following:

from __future__ import print_function

import time
import libica.openapi.libtes
from libica.openapi.libtes.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libtes.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libtes.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'


# Enter a context with an instance of the API client
with libica.openapi.libtes.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libtes.TaskRunsApi(api_client)
    run_id = 'run_id_example' # str | 

    try:
        # Abort a task run
        api_response = api_instance.abort_task_run(run_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TaskRunsApi->abort_task_run: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://aps2.platform.illumina.com

Class Method HTTP request Description
TaskRunsApi abort_task_run PUT /v1/tasks/runs/{runId}:abort Abort a task run
TaskRunsApi create_task_run POST /v1/tasks/runs Create and launch a task run
TaskRunsApi get_task_run GET /v1/tasks/runs/{runId} Get the status of a task run
TaskRunsApi heartbeat_task_run POST /v1/tasks/runs/{runId}:heartbeat Heartbeat for a task run
TaskRunsApi list_task_runs GET /v1/tasks/runs Get a list of task runs
TaskVersionsApi create_task_version POST /v1/tasks/{taskId}/versions Create a task version
TaskVersionsApi get_task_version GET /v1/tasks/{taskId}/versions/{versionId} Get the details of a task version
TaskVersionsApi launch_task_run POST /v1/tasks/{taskId}/versions/{versionId}:launch Launch a task version
TaskVersionsApi list_task_versions GET /v1/tasks/{taskId}/versions Get a list of versions
TaskVersionsApi update_task_version PATCH /v1/tasks/{taskId}/versions/{versionId} Update task version properties
TasksApi create_task POST /v1/tasks Create a Task
TasksApi get_task GET /v1/tasks/{taskId} Get the details of a Task
TasksApi list_tasks GET /v1/tasks Get a list of tasks
TasksApi update_task PATCH /v1/tasks/{taskId} Update an existing task.

Documentation For Models

Documentation For Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author