Skip to content

Latest commit

 

History

History
158 lines (116 loc) · 4.87 KB

JobsApi.md

File metadata and controls

158 lines (116 loc) · 4.87 KB
Raw

collibra_core.JobsApi

All URIs are relative to http://localhost/rest/2.0

Method HTTP request Description
cancel_job POST /jobs/{jobId}/canceled Cancels given Job.
get_job GET /jobs/{jobId} Returns the Job identified by the given UUID.

cancel_job

cancel_job(job_id, cancel_job_request=cancel_job_request)

Cancels given Job.

Calling this endpoint will return immediately and not wait until the Job is actually stopped.

Example

  • Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.JobsApi(api_client)
    job_id = 'job_id_example' # str | The unique identifier of the Job.
cancel_job_request = collibra_core.CancelJobRequest() # CancelJobRequest |  (optional)

    try:
        # Cancels given Job.
        api_instance.cancel_job(job_id, cancel_job_request=cancel_job_request)
    except ApiException as e:
        print("Exception when calling JobsApi->cancel_job: %s\n" % e)

Parameters

Name Type Description Notes
job_id str The unique identifier of the Job.
cancel_job_request CancelJobRequest [optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
202 Job cancellation accepted. -

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

get_job

Job get_job(job_id)

Returns the Job identified by the given UUID.

Returns the Job identified by the given UUID.

Example

  • Basic Authentication (basicAuth):
from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.JobsApi(api_client)
    job_id = 'job_id_example' # str | The ID of the job.

    try:
        # Returns the Job identified by the given UUID.
        api_response = api_instance.get_job(job_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling JobsApi->get_job: %s\n" % e)

Parameters

Name Type Description Notes
job_id str The ID of the job.

Return type

Job

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Job found. -
404 Job not found. -

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