{"id":19383809,"url":"https://github.com/airbytehq/airbyte-api-java-sdk","last_synced_at":"2025-07-11T18:40:45.554Z","repository":{"id":153529811,"uuid":"618272792","full_name":"airbytehq/airbyte-api-java-sdk","owner":"airbytehq","description":"Java SDK for Airbyte API","archived":false,"fork":false,"pushed_at":"2025-07-11T00:27:17.000Z","size":10841,"stargazers_count":19,"open_issues_count":6,"forks_count":9,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-11T05:54:41.536Z","etag":null,"topics":["airbyte","api","java","sdk"],"latest_commit_sha":null,"homepage":"https://api.airbyte.com/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/airbytehq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-24T05:35:51.000Z","updated_at":"2025-05-28T16:42:34.000Z","dependencies_parsed_at":"2023-05-19T05:30:36.906Z","dependency_job_id":"db0d025a-d980-44f4-bbea-cb5ad4546842","html_url":"https://github.com/airbytehq/airbyte-api-java-sdk","commit_stats":null,"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"purl":"pkg:github/airbytehq/airbyte-api-java-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbytehq%2Fairbyte-api-java-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbytehq%2Fairbyte-api-java-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbytehq%2Fairbyte-api-java-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbytehq%2Fairbyte-api-java-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/airbytehq","download_url":"https://codeload.github.com/airbytehq/airbyte-api-java-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbytehq%2Fairbyte-api-java-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264874019,"owners_count":23676990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["airbyte","api","java","sdk"],"created_at":"2024-11-10T09:27:58.364Z","updated_at":"2025-07-11T18:40:45.539Z","avatar_url":"https://github.com/airbytehq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# public-api\n\nDeveloper-friendly \u0026 type-safe Java SDK specifically catered to leverage *public-api* API.\n\n\u003cdiv align=\"left\"\u003e\n    \u003ca href=\"https://www.speakeasy.com/?utm_source=public-api\u0026utm_campaign=java\"\u003e\u003cimg src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge\u0026logoColor=FBE331\u0026logo=speakeasy\u0026labelColor=545454\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://mit-license.org/\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- Start Summary [summary] --\u003e\n## Summary\n\nairbyte-api: Programmatically control Airbyte Cloud, OSS \u0026 Enterprise.\n\u003c!-- End Summary [summary] --\u003e\n\n\u003c!-- Start Table of Contents [toc] --\u003e\n## Table of Contents\n\u003c!-- $toc-max-depth=2 --\u003e\n* [public-api](#public-api)\n  * [SDK Installation](#sdk-installation)\n  * [SDK Example Usage](#sdk-example-usage)\n  * [Authentication](#authentication)\n  * [Available Resources and Operations](#available-resources-and-operations)\n  * [Error Handling](#error-handling)\n  * [Server Selection](#server-selection)\n* [Development](#development)\n  * [Maturity](#maturity)\n  * [Contributions](#contributions)\n\n\u003c!-- End Table of Contents [toc] --\u003e\n\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\n### Getting started\n\nJDK 11 or later is required.\n\nThe samples below show how a published SDK artifact is used:\n\nGradle:\n```groovy\nimplementation 'com.airbyte:api:2.0.0'\n```\n\nMaven:\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.airbyte\u003c/groupId\u003e\n    \u003cartifactId\u003eapi\u003c/artifactId\u003e\n    \u003cversion\u003e2.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### How to build\nAfter cloning the git repository to your file system you can build the SDK artifact from source to the `build` directory by running `./gradlew build` on *nix systems or `gradlew.bat` on Windows systems.\n\nIf you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):\n\nOn *nix:\n```bash\n./gradlew publishToMavenLocal -Pskip.signing\n```\nOn Windows:\n```bash\ngradlew.bat publishToMavenLocal -Pskip.signing\n```\n\n### Logging\nA logging framework/facade has not yet been adopted but is under consideration.\n\nFor request and response logging (especially json bodies) use:\n```java\nSpeakeasyHTTPClient.setDebugLogging(true); // experimental API only (may change without warning)\n```\nExample output:\n```\nSending request: http://localhost:35123/bearer#global GET\nRequest headers: {Accept=[application/json], Authorization=[******], Client-Level-Header=[added by client], Idempotency-Key=[some-key], x-speakeasy-user-agent=[speakeasy-sdk/java 0.0.1 internal 0.1.0 org.openapis.openapi]}\nReceived response: (GET http://localhost:35123/bearer#global) 200\nResponse headers: {access-control-allow-credentials=[true], access-control-allow-origin=[*], connection=[keep-alive], content-length=[50], content-type=[application/json], date=[Wed, 09 Apr 2025 01:43:29 GMT], server=[gunicorn/19.9.0]}\nResponse body:\n{\n  \"authenticated\": true, \n  \"token\": \"global\"\n}\n```\nWARNING: This should only used for temporary debugging purposes. Leaving this option on in a production system could expose credentials/secrets in logs. \u003ci\u003eAuthorization\u003c/i\u003e headers are redacted by default and there is the ability to specify redacted header names via `SpeakeasyHTTPClient.setRedactedHeaders`.\n\nAnother option is to set the System property `-Djdk.httpclient.HttpClient.log=all`. However, this second option does not log bodies.\n\u003c!-- End SDK Installation [installation] --\u003e\n\n\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```java\npackage hello.world;\n\nimport com.airbyte.api.Airbyte;\nimport com.airbyte.api.models.operations.CreateConnectionResponse;\nimport com.airbyte.api.models.shared.*;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws Exception {\n\n        Airbyte sdk = Airbyte.builder()\n                .security(Security.builder()\n                    .basicAuth(SchemeBasicAuth.builder()\n                        .password(\"\")\n                        .username(\"\")\n                        .build())\n                    .build())\n            .build();\n\n        ConnectionCreateRequest req = ConnectionCreateRequest.builder()\n                .destinationId(\"e478de0d-a3a0-475c-b019-25f7dd29e281\")\n                .sourceId(\"95e66a59-8045-4307-9678-63bc3c9b8c93\")\n                .name(\"Postgres-to-Bigquery\")\n                .build();\n\n        CreateConnectionResponse res = sdk.connections().createConnection()\n                .request(req)\n                .call();\n\n        if (res.connectionResponse().isPresent()) {\n            // handle response\n        }\n    }\n}\n```\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security schemes globally:\n\n| Name                | Type   | Scheme       |\n| ------------------- | ------ | ------------ |\n| `basicAuth`         | http   | HTTP Basic   |\n| `bearerAuth`        | http   | HTTP Bearer  |\n| `clientCredentials` | oauth2 | OAuth2 token |\n\nYou can set the security parameters through the `security` builder method when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:\n```java\npackage hello.world;\n\nimport com.airbyte.api.Airbyte;\nimport com.airbyte.api.models.operations.CreateConnectionResponse;\nimport com.airbyte.api.models.shared.*;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws Exception {\n\n        Airbyte sdk = Airbyte.builder()\n                .security(Security.builder()\n                    .basicAuth(SchemeBasicAuth.builder()\n                        .password(\"\")\n                        .username(\"\")\n                        .build())\n                    .build())\n            .build();\n\n        ConnectionCreateRequest req = ConnectionCreateRequest.builder()\n                .destinationId(\"e478de0d-a3a0-475c-b019-25f7dd29e281\")\n                .sourceId(\"95e66a59-8045-4307-9678-63bc3c9b8c93\")\n                .name(\"Postgres-to-Bigquery\")\n                .build();\n\n        CreateConnectionResponse res = sdk.connections().createConnection()\n                .request(req)\n                .call();\n\n        if (res.connectionResponse().isPresent()) {\n            // handle response\n        }\n    }\n}\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n\u003cdetails open\u003e\n\u003csummary\u003eAvailable methods\u003c/summary\u003e\n\n\n### [connections()](docs/sdks/connections/README.md)\n\n* [createConnection](docs/sdks/connections/README.md#createconnection) - Create a connection\n* [deleteConnection](docs/sdks/connections/README.md#deleteconnection) - Delete a Connection\n* [getConnection](docs/sdks/connections/README.md#getconnection) - Get Connection details\n* [listConnections](docs/sdks/connections/README.md#listconnections) - List connections\n* [patchConnection](docs/sdks/connections/README.md#patchconnection) - Update Connection details\n\n### [declarativeSourceDefinitions()](docs/sdks/declarativesourcedefinitions/README.md)\n\n* [createDeclarativeSourceDefinition](docs/sdks/declarativesourcedefinitions/README.md#createdeclarativesourcedefinition) - Create a declarative source definition.\n* [deleteDeclarativeSourceDefinition](docs/sdks/declarativesourcedefinitions/README.md#deletedeclarativesourcedefinition) - Delete a declarative source definition.\n* [getDeclarativeSourceDefinition](docs/sdks/declarativesourcedefinitions/README.md#getdeclarativesourcedefinition) - Get declarative source definition details.\n* [listDeclarativeSourceDefinitions](docs/sdks/declarativesourcedefinitions/README.md#listdeclarativesourcedefinitions) - List declarative source definitions.\n* [updateDeclarativeSourceDefinition](docs/sdks/declarativesourcedefinitions/README.md#updatedeclarativesourcedefinition) - Update declarative source definition details.\n\n### [destinationDefinitions()](docs/sdks/destinationdefinitions/README.md)\n\n* [createDestinationDefinition](docs/sdks/destinationdefinitions/README.md#createdestinationdefinition) - Create a destination definition.\n* [deleteDestinationDefinition](docs/sdks/destinationdefinitions/README.md#deletedestinationdefinition) - Delete a destination definition.\n* [getDestinationDefinition](docs/sdks/destinationdefinitions/README.md#getdestinationdefinition) - Get destination definition details.\n* [listDestinationDefinitions](docs/sdks/destinationdefinitions/README.md#listdestinationdefinitions) - List destination definitions.\n* [updateDestinationDefinition](docs/sdks/destinationdefinitions/README.md#updatedestinationdefinition) - Update destination definition details.\n\n### [destinations()](docs/sdks/destinations/README.md)\n\n* [createDestination](docs/sdks/destinations/README.md#createdestination) - Create a destination\n* [deleteDestination](docs/sdks/destinations/README.md#deletedestination) - Delete a Destination\n* [getDestination](docs/sdks/destinations/README.md#getdestination) - Get Destination details\n* [listDestinations](docs/sdks/destinations/README.md#listdestinations) - List destinations\n* [patchDestination](docs/sdks/destinations/README.md#patchdestination) - Update a Destination\n* [putDestination](docs/sdks/destinations/README.md#putdestination) - Update a Destination and fully overwrite it\n\n### [health()](docs/sdks/health/README.md)\n\n* [getHealthCheck](docs/sdks/health/README.md#gethealthcheck) - Health Check\n\n### [jobs()](docs/sdks/jobs/README.md)\n\n* [cancelJob](docs/sdks/jobs/README.md#canceljob) - Cancel a running Job\n* [createJob](docs/sdks/jobs/README.md#createjob) - Trigger a sync or reset job of a connection\n* [getJob](docs/sdks/jobs/README.md#getjob) - Get Job status and details\n* [listJobs](docs/sdks/jobs/README.md#listjobs) - List Jobs by sync type\n\n### [organizations()](docs/sdks/organizations/README.md)\n\n* [listOrganizationsForUser](docs/sdks/organizations/README.md#listorganizationsforuser) - List all organizations for a user\n\n### [permissions()](docs/sdks/permissions/README.md)\n\n* [createPermission](docs/sdks/permissions/README.md#createpermission) - Create a permission\n* [deletePermission](docs/sdks/permissions/README.md#deletepermission) - Delete a Permission\n* [getPermission](docs/sdks/permissions/README.md#getpermission) - Get Permission details\n* [listPermissions](docs/sdks/permissions/README.md#listpermissions) - List Permissions by user id\n* [updatePermission](docs/sdks/permissions/README.md#updatepermission) - Update a permission\n\n### [sourceDefinitions()](docs/sdks/sourcedefinitions/README.md)\n\n* [createSourceDefinition](docs/sdks/sourcedefinitions/README.md#createsourcedefinition) - Create a source definition.\n* [deleteSourceDefinition](docs/sdks/sourcedefinitions/README.md#deletesourcedefinition) - Delete a source definition.\n* [getSourceDefinition](docs/sdks/sourcedefinitions/README.md#getsourcedefinition) - Get source definition details.\n* [listSourceDefinitions](docs/sdks/sourcedefinitions/README.md#listsourcedefinitions) - List source definitions.\n* [updateSourceDefinition](docs/sdks/sourcedefinitions/README.md#updatesourcedefinition) - Update source definition details.\n\n### [sources()](docs/sdks/sources/README.md)\n\n* [createSource](docs/sdks/sources/README.md#createsource) - Create a source\n* [deleteSource](docs/sdks/sources/README.md#deletesource) - Delete a Source\n* [getSource](docs/sdks/sources/README.md#getsource) - Get Source details\n* [initiateOAuth](docs/sdks/sources/README.md#initiateoauth) - Initiate OAuth for a source\n* [listSources](docs/sdks/sources/README.md#listsources) - List sources\n* [patchSource](docs/sdks/sources/README.md#patchsource) - Update a Source\n* [putSource](docs/sdks/sources/README.md#putsource) - Update a Source and fully overwrite it\n\n### [streams()](docs/sdks/streams/README.md)\n\n* [getStreamProperties](docs/sdks/streams/README.md#getstreamproperties) - Get stream properties\n\n### [tags()](docs/sdks/tags/README.md)\n\n* [createTag](docs/sdks/tags/README.md#createtag) - Create a tag\n* [deleteTag](docs/sdks/tags/README.md#deletetag) - Delete a tag\n* [getTag](docs/sdks/tags/README.md#gettag) - Get a tag\n* [listTags](docs/sdks/tags/README.md#listtags) - List all tags\n* [updateTag](docs/sdks/tags/README.md#updatetag) - Update a tag\n\n### [users()](docs/sdks/users/README.md)\n\n* [listUsersWithinAnOrganization](docs/sdks/users/README.md#listuserswithinanorganization) - List all users within an organization\n\n### [workspaces()](docs/sdks/workspaces/README.md)\n\n* [createOrUpdateWorkspaceOAuthCredentials](docs/sdks/workspaces/README.md#createorupdateworkspaceoauthcredentials) - Create OAuth override credentials for a workspace and source type.\n* [createWorkspace](docs/sdks/workspaces/README.md#createworkspace) - Create a workspace\n* [deleteWorkspace](docs/sdks/workspaces/README.md#deleteworkspace) - Delete a Workspace\n* [getWorkspace](docs/sdks/workspaces/README.md#getworkspace) - Get Workspace details\n* [listWorkspaces](docs/sdks/workspaces/README.md#listworkspaces) - List workspaces\n* [updateWorkspace](docs/sdks/workspaces/README.md#updateworkspace) - Update a workspace\n\n\u003c/details\u003e\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\nBy default, an API error will throw a `models/errors/SDKError` exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `createConnection` method throws the following exceptions:\n\n| Error Type             | Status Code | Content Type |\n| ---------------------- | ----------- | ------------ |\n| models/errors/SDKError | 4XX, 5XX    | \\*/\\*        |\n\n### Example\n\n```java\npackage hello.world;\n\nimport com.airbyte.api.Airbyte;\nimport com.airbyte.api.models.operations.CreateConnectionResponse;\nimport com.airbyte.api.models.shared.*;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws Exception {\n\n        Airbyte sdk = Airbyte.builder()\n                .security(Security.builder()\n                    .basicAuth(SchemeBasicAuth.builder()\n                        .password(\"\")\n                        .username(\"\")\n                        .build())\n                    .build())\n            .build();\n\n        ConnectionCreateRequest req = ConnectionCreateRequest.builder()\n                .destinationId(\"e478de0d-a3a0-475c-b019-25f7dd29e281\")\n                .sourceId(\"95e66a59-8045-4307-9678-63bc3c9b8c93\")\n                .name(\"Postgres-to-Bigquery\")\n                .build();\n\n        CreateConnectionResponse res = sdk.connections().createConnection()\n                .request(req)\n                .call();\n\n        if (res.connectionResponse().isPresent()) {\n            // handle response\n        }\n    }\n}\n```\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- Start Server Selection [server] --\u003e\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can be overridden globally using the `.serverURL(String serverUrl)` builder method when initializing the SDK client instance. For example:\n```java\npackage hello.world;\n\nimport com.airbyte.api.Airbyte;\nimport com.airbyte.api.models.operations.CreateConnectionResponse;\nimport com.airbyte.api.models.shared.*;\nimport java.lang.Exception;\n\npublic class Application {\n\n    public static void main(String[] args) throws Exception {\n\n        Airbyte sdk = Airbyte.builder()\n                .serverURL(\"https://api.airbyte.com/v1\")\n                .security(Security.builder()\n                    .basicAuth(SchemeBasicAuth.builder()\n                        .password(\"\")\n                        .username(\"\")\n                        .build())\n                    .build())\n            .build();\n\n        ConnectionCreateRequest req = ConnectionCreateRequest.builder()\n                .destinationId(\"e478de0d-a3a0-475c-b019-25f7dd29e281\")\n                .sourceId(\"95e66a59-8045-4307-9678-63bc3c9b8c93\")\n                .name(\"Postgres-to-Bigquery\")\n                .build();\n\n        CreateConnectionResponse res = sdk.connections().createConnection()\n                .request(req)\n                .call();\n\n        if (res.connectionResponse().isPresent()) {\n            // handle response\n        }\n    }\n}\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=public-api\u0026utm_campaign=java)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairbytehq%2Fairbyte-api-java-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairbytehq%2Fairbyte-api-java-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairbytehq%2Fairbyte-api-java-sdk/lists"}