Skip to content

README.md

Latest commit

 

History

History
314 lines (244 loc) · 12.6 KB

README.md

File metadata and controls

314 lines (244 loc) · 12.6 KB
Raw

Jobs

(jobs())

Available Operations

  • 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

cancelJob

Cancel a running Job

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.*;
import com.airbyte.api.models.shared.*;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
                .build();

            CancelJobRequest req = CancelJobRequest.builder()
                .jobId(801771L)
                .build();

            CancelJobResponse res = sdk.jobs().cancelJob()
                .request(req)
                .call();

            if (res.jobResponse().isPresent()) {
                // handle response
            }
        } catch (com.airbyte.api.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request com.airbyte.api.models.operations.CancelJobRequest ✔️ The request object to use for the request.

Response

com.airbyte.api.models.operations.CancelJobResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

createJob

Trigger a sync or reset job of a connection

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.*;
import com.airbyte.api.models.shared.*;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
                .build();

            JobCreateRequest req = JobCreateRequest.builder()
                .connectionId("<value>")
                .jobType(JobTypeEnum.RESET)
                .build();

            CreateJobResponse res = sdk.jobs().createJob()
                .request(req)
                .call();

            if (res.jobResponse().isPresent()) {
                // handle response
            }
        } catch (com.airbyte.api.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request com.airbyte.api.models.shared.JobCreateRequest ✔️ The request object to use for the request.

Response

com.airbyte.api.models.operations.CreateJobResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

getJob

Get Job status and details

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.*;
import com.airbyte.api.models.shared.*;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
                .build();

            GetJobRequest req = GetJobRequest.builder()
                .jobId(131101L)
                .build();

            GetJobResponse res = sdk.jobs().getJob()
                .request(req)
                .call();

            if (res.jobResponse().isPresent()) {
                // handle response
            }
        } catch (com.airbyte.api.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request com.airbyte.api.models.operations.GetJobRequest ✔️ The request object to use for the request.

Response

com.airbyte.api.models.operations.GetJobResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*

listJobs

List Jobs by sync type

Example Usage

package hello.world;

import com.airbyte.api.Airbyte;
import com.airbyte.api.models.operations.*;
import com.airbyte.api.models.shared.*;
import com.airbyte.api.models.shared.Security;
import com.airbyte.api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            Airbyte sdk = Airbyte.builder()
                .security(Security.builder()
                    .basicAuth(SchemeBasicAuth.builder()
                        .password("")
                        .username("")
                        .build())
                    .build())
                .build();

            ListJobsRequest req = ListJobsRequest.builder()
                .createdAtEnd(OffsetDateTime.parse("1687450500000"))
                .createdAtStart(OffsetDateTime.parse("1687450500000"))
                .orderBy("updatedAt|DESC")
                .updatedAtEnd(OffsetDateTime.parse("1687450500000"))
                .updatedAtStart(OffsetDateTime.parse("1687450500000"))
                .build();

            ListJobsResponse res = sdk.jobs().listJobs()
                .request(req)
                .call();

            if (res.jobsResponse().isPresent()) {
                // handle response
            }
        } catch (com.airbyte.api.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

Parameter Type Required Description
request com.airbyte.api.models.operations.ListJobsRequest ✔️ The request object to use for the request.

Response

com.airbyte.api.models.operations.ListJobsResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*