Skip to content

Latest commit

 

History

History
201 lines (138 loc) · 6.06 KB

README.md

File metadata and controls

201 lines (138 loc) · 6.06 KB

Jobs

(jobs)

Overview

Available Operations

cancel_job

Cancel a running Job

Example Usage

import airbyte_api
from airbyte_api import api, models

s = airbyte_api.AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password='',
            username='',
        ),
    ),
)


res = s.jobs.cancel_job(request=api.CancelJobRequest(
    job_id=801771,
))

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

Parameters

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

Response

api.CancelJobResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

create_job

Trigger a sync or reset job of a connection

Example Usage

import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password='',
            username='',
        ),
    ),
)


res = s.jobs.create_job(request=models.JobCreateRequest(
    connection_id='e735894a-e773-4938-969f-45f53957b75b',
    job_type=models.JobTypeEnum.SYNC,
))

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

Parameters

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

Response

api.CreateJobResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

get_job

Get Job status and details

Example Usage

import airbyte_api
from airbyte_api import api, models

s = airbyte_api.AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password='',
            username='',
        ),
    ),
)


res = s.jobs.get_job(request=api.GetJobRequest(
    job_id=131101,
))

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

Parameters

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

Response

api.GetJobResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*

list_jobs

List Jobs by sync type

Example Usage

import airbyte_api
import dateutil.parser
from airbyte_api import api, models

s = airbyte_api.AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password='',
            username='',
        ),
    ),
)


res = s.jobs.list_jobs(request=api.ListJobsRequest(
    created_at_end=dateutil.parser.isoparse('1687450500000'),
    created_at_start=dateutil.parser.isoparse('1687450500000'),
    order_by='updatedAt|DESC',
    updated_at_end=dateutil.parser.isoparse('1687450500000'),
    updated_at_start=dateutil.parser.isoparse('1687450500000'),
))

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

Parameters

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

Response

api.ListJobsResponse

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*