Skip to content

Latest commit

 

History

History
192 lines (134 loc) · 6.82 KB

File metadata and controls

192 lines (134 loc) · 6.82 KB

Jobs

(jobs)

Available Operations

cancel_job

Cancel a running Job

Example Usage

import airbyte
from airbyte.models import operations, shared

s = airbyte.Airbyte(
    security=shared.Security(
        basic_auth=shared.SchemeBasicAuth(
            password="<YOUR_PASSWORD_HERE>",
            username="<YOUR_USERNAME_HERE>",
        ),
    ),
)

req = operations.CancelJobRequest(
    job_id=801771,
)

res = s.jobs.cancel_job(req)

if res.job_response is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.CancelJobRequest ✔️ The request object to use for the request.

Response

operations.CancelJobResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4x-5xx /

create_job

Trigger a sync or reset job of a connection

Example Usage

import airbyte
from airbyte.models import shared

s = airbyte.Airbyte(
    security=shared.Security(
        basic_auth=shared.SchemeBasicAuth(
            password="<YOUR_PASSWORD_HERE>",
            username="<YOUR_USERNAME_HERE>",
        ),
    ),
)

req = shared.JobCreateRequest(
    connection_id='18dccc91-0ab1-4f72-9ed7-0b8fc27c5826',
    job_type=shared.JobTypeEnum.SYNC,
)

res = s.jobs.create_job(req)

if res.job_response is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request shared.JobCreateRequest ✔️ The request object to use for the request.

Response

operations.CreateJobResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4x-5xx /

get_job

Get Job status and details

Example Usage

import airbyte
from airbyte.models import operations, shared

s = airbyte.Airbyte(
    security=shared.Security(
        basic_auth=shared.SchemeBasicAuth(
            password="<YOUR_PASSWORD_HERE>",
            username="<YOUR_USERNAME_HERE>",
        ),
    ),
)

req = operations.GetJobRequest(
    job_id=131101,
)

res = s.jobs.get_job(req)

if res.job_response is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.GetJobRequest ✔️ The request object to use for the request.

Response

operations.GetJobResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4x-5xx /

list_jobs

List Jobs by sync type

Example Usage

import airbyte
from airbyte.models import operations, shared

s = airbyte.Airbyte(
    security=shared.Security(
        basic_auth=shared.SchemeBasicAuth(
            password="<YOUR_PASSWORD_HERE>",
            username="<YOUR_USERNAME_HERE>",
        ),
    ),
)

req = operations.ListJobsRequest()

res = s.jobs.list_jobs(req)

if res.jobs_response is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request operations.ListJobsRequest ✔️ The request object to use for the request.

Response

operations.ListJobsResponse

Errors

Error Object Status Code Content Type
errors.SDKError 4x-5xx /