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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

# \OperationApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**check_operation**](OperationApi.md#check_operation) | **POST** /v1/operations/check | Check if an operation to be created is valid
[**create_operation**](OperationApi.md#create_operation) | **POST** /v1/operations/create | Create an operation to be applied as part of a connection pipeline
[**delete_operation**](OperationApi.md#delete_operation) | **POST** /v1/operations/delete | Delete an operation
[**get_operation**](OperationApi.md#get_operation) | **POST** /v1/operations/get | Returns an operation
[**list_operations_for_connection**](OperationApi.md#list_operations_for_connection) | **POST** /v1/operations/list | Returns all operations for a connection.
[**update_operation**](OperationApi.md#update_operation) | **POST** /v1/operations/update | Update an operation



## check_operation

> crate::models::CheckOperationRead check_operation(operator_configuration)
Check if an operation to be created is valid

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**operator_configuration** | [**OperatorConfiguration**](OperatorConfiguration.md) |  | [required] |

### Return type

[**crate::models::CheckOperationRead**](CheckOperationRead.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)


## create_operation

> crate::models::OperationRead create_operation(operation_create)
Create an operation to be applied as part of a connection pipeline

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**operation_create** | [**OperationCreate**](OperationCreate.md) |  | [required] |

### Return type

[**crate::models::OperationRead**](OperationRead.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)


## delete_operation

> delete_operation(operation_id_request_body)
Delete an operation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**operation_id_request_body** | [**OperationIdRequestBody**](OperationIdRequestBody.md) |  | [required] |

### Return type

 (empty response body)

### 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)


## get_operation

> crate::models::OperationRead get_operation(operation_id_request_body)
Returns an operation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**operation_id_request_body** | [**OperationIdRequestBody**](OperationIdRequestBody.md) |  | [required] |

### Return type

[**crate::models::OperationRead**](OperationRead.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)


## list_operations_for_connection

> crate::models::OperationReadList list_operations_for_connection(connection_id_request_body)
Returns all operations for a connection.

List operations for connection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**connection_id_request_body** | [**ConnectionIdRequestBody**](ConnectionIdRequestBody.md) |  | [required] |

### Return type

[**crate::models::OperationReadList**](OperationReadList.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)


## update_operation

> crate::models::OperationRead update_operation(operation_update)
Update an operation

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**operation_update** | [**OperationUpdate**](OperationUpdate.md) |  | [required] |

### Return type

[**crate::models::OperationRead**](OperationRead.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)