https://github.com/speakeasy-sdks/airbyte-java-sdk
A Java SDK for accessing the Airbyte API.
https://github.com/speakeasy-sdks/airbyte-java-sdk
airbyte api connector java sdk
Last synced: about 1 year ago
JSON representation
A Java SDK for accessing the Airbyte API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/airbyte-java-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-03-03T22:18:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:13:16.000Z (about 2 years ago)
- Last Synced: 2025-04-11T23:48:50.944Z (about 1 year ago)
- Topics: airbyte, api, connector, java, sdk
- Language: Java
- Homepage: https://reference.airbyte.com/reference/start
- Size: 432 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Authentication
Developers will need to create an API Key within your Developer Portal to make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see a walkthrough demo here 🎦
The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.
***(Installation will not work until published to a package manager, please clone locally and run `maven install` to try out the artifact locally)***
## SDK Installation
### Gradle
```groovy
implementation 'com.airbyte.api:sdk:1.0.0'
```
## SDK Example Usage
```java
package hello.world;
import com.airbyte.api.Airbyte;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.models.operations.CreateConnectionResponse;
import com.airbyte.api.models.shared.ConnectionCreate;
public class Application {
public static void main(String[] args) {
try {
Airbyte sdk = Airbyte.builder()
.setSecurity(new Security() {{
bearerAuth = "Bearer YOUR_BEARER_TOKEN_HERE";
}})
.build();
com.airbyte.api.models.shared.ConnectionCreate req = new ConnectionCreate() {{
destinationId = "unde";
name = "deserunt";
sourceId = "porro";
}}
CreateConnectionResponse res = sdk.connections.createConnection(req);
if (res.connectionId.isPresent()) {
// handle response
}
} catch (Exception e) {
// handle exception
}
```
## SDK Available Operations
### connections
* `createConnection` - Create a connection
### destinations
* `createDestination` - Create a destination
### jobs
* `cancelJob` - Cancel a running Job
* `createJob` - Trigger a sync or reset job of a connection
* `getJob` - Get Job status and details
* `listJobs` - List Jobs by sync type
### sources
* `createSource` - Create a source
### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)