Skip to content

Latest commit

 

History

History
449 lines (325 loc) · 17.4 KB

README.md

File metadata and controls

449 lines (325 loc) · 17.4 KB

Sources

(sources())

Overview

Available Operations

createSource

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

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateSourceResponse;
import com.airbyte.api.models.shared.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        SourceCreateRequest req = SourceCreateRequest.builder()
                .configuration(SourceConfiguration.of(SourcePocket.builder()
                    .accessToken("<value>")
                    .consumerKey("<value>")
                    .build()))
                .name("My Source")
                .workspaceId("744cc0ed-7f05-4949-9e60-2a814f90c035")
                .build();

        CreateSourceResponse res = sdk.sources().createSource()
                .request(req)
                .call();

        if (res.sourceResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CreateSourceResponse

Errors

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

deleteSource

Delete a Source

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.DeleteSourceRequest;
import com.airbyte.api.models.operations.DeleteSourceResponse;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        DeleteSourceRequest req = DeleteSourceRequest.builder()
                .sourceId("<value>")
                .build();

        DeleteSourceResponse res = sdk.sources().deleteSource()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

DeleteSourceResponse

Errors

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

getSource

Get Source details

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.GetSourceRequest;
import com.airbyte.api.models.operations.GetSourceResponse;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        GetSourceRequest req = GetSourceRequest.builder()
                .sourceId("<value>")
                .build();

        GetSourceResponse res = sdk.sources().getSource()
                .request(req)
                .call();

        if (res.sourceResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

GetSourceResponse

Errors

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

initiateOAuth

Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source.

This returns a fully formed URL for performing user authentication against the relevant source identity provider (IdP). Once authentication has been completed, the IdP will redirect to an Airbyte endpoint which will save the access and refresh tokens off as a secret and return the secret ID to the redirect URL specified in the secret_id query string parameter.

That secret ID can be used to create a source with credentials in place of actual tokens.

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.InitiateOAuthResponse;
import com.airbyte.api.models.shared.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        InitiateOauthRequest req = InitiateOauthRequest.builder()
                .redirectUrl("https://cloud.airbyte.io/v1/api/oauth/callback")
                .sourceType(OAuthActorNames.GCS)
                .workspaceId("871d9b60-11d1-44cb-8c92-c246d53bf87e")
                .build();

        InitiateOAuthResponse res = sdk.sources().initiateOAuth()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

InitiateOAuthResponse

Errors

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

listSources

List sources

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.ListSourcesRequest;
import com.airbyte.api.models.operations.ListSourcesResponse;
import com.airbyte.api.models.shared.SchemeBasicAuth;
import com.airbyte.api.models.shared.Security;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        ListSourcesRequest req = ListSourcesRequest.builder()
                .workspaceIds(List.of(
                    "df08f6b0-b364-4cc1-9b3f-96f5d2fccfb2,b0796797-de23-4fc7-a5e2-7e131314718c"))
                .build();

        ListSourcesResponse res = sdk.sources().listSources()
                .request(req)
                .call();

        if (res.sourcesResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

ListSourcesResponse

Errors

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

patchSource

Update a Source

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.PatchSourceRequest;
import com.airbyte.api.models.operations.PatchSourceResponse;
import com.airbyte.api.models.shared.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        PatchSourceRequest req = PatchSourceRequest.builder()
                .sourceId("<value>")
                .sourcePatchRequest(SourcePatchRequest.builder()
                    .configuration(SourceConfiguration.of(SourceEventee.builder()
                        .apiToken("<value>")
                        .build()))
                    .name("My Source")
                    .workspaceId("744cc0ed-7f05-4949-9e60-2a814f90c035")
                    .build())
                .build();

        PatchSourceResponse res = sdk.sources().patchSource()
                .request(req)
                .call();

        if (res.sourceResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

PatchSourceResponse

Errors

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

putSource

Update a Source and fully overwrite it

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.PutSourceRequest;
import com.airbyte.api.models.operations.PutSourceResponse;
import com.airbyte.api.models.shared.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
            .build();

        PutSourceRequest req = PutSourceRequest.builder()
                .sourceId("<value>")
                .sourcePutRequest(SourcePutRequest.builder()
                    .configuration(SourceConfiguration.of(SourceAirtable.builder()
                        .build()))
                    .name("My Source")
                    .build())
                .build();

        PutSourceResponse res = sdk.sources().putSource()
                .request(req)
                .call();

        if (res.sourceResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

PutSourceResponse

Errors

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