You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
4
+
5
+
## How to Report Issues
6
+
7
+
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
8
+
9
+
- A clear and descriptive title
10
+
- Steps to reproduce the issue
11
+
- Expected and actual behavior
12
+
- Any relevant logs, screenshots, or error messages
13
+
- Information about your environment (e.g., operating system, software versions)
14
+
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
15
+
16
+
## Issue Triage and Upstream Fixes
17
+
18
+
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
19
+
20
+
## Contact
21
+
22
+
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
Copy file name to clipboardexpand all lines: README.md
+30-10
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,29 @@ Developers will need to create an API Key within your [Developer Portal](https:/
13
13
14
14
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.
15
15
16
+
<!-- Start Summary [summary] -->
17
+
## Summary
18
+
19
+
airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
20
+
<!-- End Summary [summary] -->
21
+
22
+
<!-- Start Table of Contents [toc] -->
23
+
## Table of Contents
24
+
25
+
*[SDK Installation](#sdk-installation)
26
+
*[SDK Example Usage](#sdk-example-usage)
27
+
*[Available Resources and Operations](#available-resources-and-operations)
28
+
*[Error Handling](#error-handling)
29
+
*[Server Selection](#server-selection)
30
+
*[Custom HTTP Client](#custom-http-client)
31
+
*[Authentication](#authentication)
32
+
<!-- End Table of Contents [toc] -->
33
+
16
34
<!-- Start SDK Installation [installation] -->
17
35
## SDK Installation
18
36
37
+
The SDK can be installed using the *pip* package manager, with dependencies and metadata stored in the `setup.py` file.
38
+
19
39
```bash
20
40
pip install airbyte-api
21
41
```
@@ -33,8 +53,8 @@ from airbyte_api import models
33
53
s = airbyte_api.AirbyteAPI(
34
54
security=models.Security(
35
55
basic_auth=models.SchemeBasicAuth(
36
-
password="<YOUR_PASSWORD_HERE>",
37
-
username="<YOUR_USERNAME_HERE>",
56
+
password="",
57
+
username="",
38
58
),
39
59
),
40
60
)
@@ -149,8 +169,8 @@ from airbyte_api import errors, models
149
169
s = airbyte_api.AirbyteAPI(
150
170
security=models.Security(
151
171
basic_auth=models.SchemeBasicAuth(
152
-
password="<YOUR_PASSWORD_HERE>",
153
-
username="<YOUR_USERNAME_HERE>",
172
+
password="",
173
+
username="",
154
174
),
155
175
),
156
176
)
@@ -198,8 +218,8 @@ s = airbyte_api.AirbyteAPI(
198
218
server_idx=0,
199
219
security=models.Security(
200
220
basic_auth=models.SchemeBasicAuth(
201
-
password="<YOUR_PASSWORD_HERE>",
202
-
username="<YOUR_USERNAME_HERE>",
221
+
password="",
222
+
username="",
203
223
),
204
224
),
205
225
)
@@ -230,8 +250,8 @@ s = airbyte_api.AirbyteAPI(
230
250
server_url="https://api.airbyte.com/v1",
231
251
security=models.Security(
232
252
basic_auth=models.SchemeBasicAuth(
233
-
password="<YOUR_PASSWORD_HERE>",
234
-
username="<YOUR_USERNAME_HERE>",
253
+
password="",
254
+
username="",
235
255
),
236
256
),
237
257
)
@@ -292,8 +312,8 @@ from airbyte_api import models
An HMAC key is a type of credential and can be associated with a service account or a user account in Cloud Storage. Read more <ahref="https://cloud.google.com/storage/docs/authentication/hmackeys">here</a>.
3
+
Authentication mechanism for Staging files and running queries
4
4
5
5
6
6
## Supported Types
7
7
8
-
### `models.HMACKey`
8
+
### `models.OAuth2Recommended`
9
9
10
10
```python
11
-
value: models.HMACKey =/* values here */
11
+
value: models.OAuth2Recommended =/* values here */
12
+
```
13
+
14
+
### `models.PersonalAccessToken`
15
+
16
+
```python
17
+
value: models.PersonalAccessToken =/* values here */
Direct loading using batched SQL INSERT statements. This method uses the BigQuery driver to convert large INSERT statements into file uploads automatically.
|`max_messages`|*Optional[int]*|:heavy_minus_sign:| Number of records to emit per stream. Min 1. Max 100 billion. ||
11
11
|`message_interval_ms`|*Optional[int]*|:heavy_minus_sign:| Interval between messages in ms. Min 0 ms. Max 60000 ms (1 minute). ||
12
12
|`seed`|*Optional[int]*|:heavy_minus_sign:| When the seed is unspecified, the current time millis will be used as the seed. Range: [0, 1000000]. | 42 |
0 commit comments