airbyte_client 0.41.0

Airbyte Client is an unofficial client library for the Airbyte API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# \DeploymentApi

All URIs are relative to *http://localhost:8000/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**export_archive**](DeploymentApi.md#export_archive) | **POST** /v1/deployment/export | Export Airbyte Configuration and Data Archive
[**export_workspace**](DeploymentApi.md#export_workspace) | **POST** /v1/deployment/export_workspace | Export Airbyte Workspace Configuration
[**import_archive**](DeploymentApi.md#import_archive) | **POST** /v1/deployment/import | Import Airbyte Configuration and Data Archive
[**import_into_workspace**](DeploymentApi.md#import_into_workspace) | **POST** /v1/deployment/import_into_workspace | Import Airbyte Configuration into Workspace (this operation might change ids of imported configurations). Note, in order to use this api endpoint, you might need to upload a temporary archive resource with 'deployment/upload_archive_resource' first 
[**upload_archive_resource**](DeploymentApi.md#upload_archive_resource) | **POST** /v1/deployment/upload_archive_resource | Upload a GZIP archive tarball and stage it in the server's cache as a temporary resource



## export_archive

> std::path::PathBuf export_archive()
Export Airbyte Configuration and Data Archive

### Parameters

This endpoint does not need any parameter.

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/x-gzip

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_workspace

> std::path::PathBuf export_workspace(workspace_id_request_body)
Export Airbyte Workspace Configuration

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace_id_request_body** | [**WorkspaceIdRequestBody**](WorkspaceIdRequestBody.md) |  | [required] |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/x-gzip

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## import_archive

> crate::models::ImportRead import_archive(body)
Import Airbyte Configuration and Data Archive

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **std::path::PathBuf** |  | [required] |

### Return type

[**crate::models::ImportRead**](ImportRead.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/x-gzip
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## import_into_workspace

> crate::models::ImportRead import_into_workspace(import_request_body)
Import Airbyte Configuration into Workspace (this operation might change ids of imported configurations). Note, in order to use this api endpoint, you might need to upload a temporary archive resource with 'deployment/upload_archive_resource' first 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**import_request_body** | [**ImportRequestBody**](ImportRequestBody.md) |  | [required] |

### Return type

[**crate::models::ImportRead**](ImportRead.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## upload_archive_resource

> crate::models::UploadRead upload_archive_resource(body)
Upload a GZIP archive tarball and stage it in the server's cache as a temporary resource

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**body** | **std::path::PathBuf** |  | [required] |

### Return type

[**crate::models::UploadRead**](UploadRead.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/x-gzip
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)