Skip to content

Latest commit

 

History

History
311 lines (218 loc) · 10.9 KB

File metadata and controls

311 lines (218 loc) · 10.9 KB

Destinations

(destinations)

Overview

Available Operations

create_destination

Creates a destination given a name, workspace id, and a json blob containing the configuration for the source.

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.destinations.create_destination(request=models.DestinationCreateRequest(
    configuration=models.DestinationOracle(
        host='instructive-mainstream.com',
        sid='<id>',
        username='Robert.Legros98',
        port=1521,
        schema='airbyte',
    ),
    name='Postgres',
    workspace_id='2155ae5a-de39-4808-af6a-16fe7b8b4ed2',
))

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

Parameters

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

Response

api.CreateDestinationResponse

Errors

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

delete_destination

Delete a Destination

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.destinations.delete_destination(request=api.DeleteDestinationRequest(
    destination_id='<value>',
))

if res is not None:
    # handle response
    pass

Parameters

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

Response

api.DeleteDestinationResponse

Errors

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

get_destination

Get Destination 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.destinations.get_destination(request=api.GetDestinationRequest(
    destination_id='<value>',
))

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

Parameters

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

Response

api.GetDestinationResponse

Errors

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

list_destinations

List destinations

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.destinations.list_destinations(request=api.ListDestinationsRequest())

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

Parameters

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

Response

api.ListDestinationsResponse

Errors

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

patch_destination

Update a Destination

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.destinations.patch_destination(request=api.PatchDestinationRequest(
    destination_id='<value>',
    destination_patch_request=models.DestinationPatchRequest(
        configuration=models.DestinationDevNull(
            test_destination=models.Failing(
                num_messages=992227,
                test_destination_type=models.DestinationDevNullSchemasTestDestinationTestDestinationType.FAILING,
            ),
        ),
        name='My Destination',
    ),
))

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

Parameters

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

Response

api.PatchDestinationResponse

Errors

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

put_destination

Update a Destination and fully overwrite it

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.destinations.put_destination(request=api.PutDestinationRequest(
    destination_id='<value>',
    destination_put_request=models.DestinationPutRequest(
        configuration=models.DestinationConvex(
            access_key='<value>',
            deployment_url='https://cluttered-owl-337.convex.cloud',
        ),
        name='My Destination',
    ),
))

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

Parameters

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

Response

api.PutDestinationResponse

Errors

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