Skip to content

Latest commit

 

History

History
311 lines (223 loc) · 12.3 KB

README.md

File metadata and controls

311 lines (223 loc) · 12.3 KB

Connections

(connections())

Overview

Available Operations

createConnection

Create a connection

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.CreateConnectionResponse;
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();

        ConnectionCreateRequest req = ConnectionCreateRequest.builder()
                .destinationId("e478de0d-a3a0-475c-b019-25f7dd29e281")
                .sourceId("95e66a59-8045-4307-9678-63bc3c9b8c93")
                .name("Postgres-to-Bigquery")
                .build();

        CreateConnectionResponse res = sdk.connections().createConnection()
                .request(req)
                .call();

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

Parameters

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

Response

CreateConnectionResponse

Errors

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

deleteConnection

Delete a Connection

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.DeleteConnectionRequest;
import com.airbyte.api.models.operations.DeleteConnectionResponse;
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();

        DeleteConnectionRequest req = DeleteConnectionRequest.builder()
                .connectionId("<value>")
                .build();

        DeleteConnectionResponse res = sdk.connections().deleteConnection()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

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

Response

DeleteConnectionResponse

Errors

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

getConnection

Get Connection details

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.GetConnectionRequest;
import com.airbyte.api.models.operations.GetConnectionResponse;
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();

        GetConnectionRequest req = GetConnectionRequest.builder()
                .connectionId("<value>")
                .build();

        GetConnectionResponse res = sdk.connections().getConnection()
                .request(req)
                .call();

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

Parameters

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

Response

GetConnectionResponse

Errors

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

listConnections

List connections

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.ListConnectionsRequest;
import com.airbyte.api.models.operations.ListConnectionsResponse;
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();

        ListConnectionsRequest req = ListConnectionsRequest.builder()
                .build();

        ListConnectionsResponse res = sdk.connections().listConnections()
                .request(req)
                .call();

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

Parameters

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

Response

ListConnectionsResponse

Errors

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

patchConnection

Update Connection details

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.PatchConnectionRequest;
import com.airbyte.api.models.operations.PatchConnectionResponse;
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();

        PatchConnectionRequest req = PatchConnectionRequest.builder()
                .connectionPatchRequest(ConnectionPatchRequest.builder()
                    .name("Postgres-to-Bigquery")
                    .build())
                .connectionId("<value>")
                .build();

        PatchConnectionResponse res = sdk.connections().patchConnection()
                .request(req)
                .call();

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

Parameters

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

Response

PatchConnectionResponse

Errors

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