tapis-streams 0.3.0

Manage Tapis Streams 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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229

# \ChannelsApi

All URIs are relative to *http://localhost:5000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_channels**](ChannelsApi.md#create_channels) | **POST** /v3/streams/channels | Create channels.
[**delete_channel**](ChannelsApi.md#delete_channel) | **DELETE** /v3/streams/channels/{channel_id} | Delete a channel
[**get_channel**](ChannelsApi.md#get_channel) | **GET** /v3/streams/channels/{channel_id} | Get channels details
[**list_alerts**](ChannelsApi.md#list_alerts) | **GET** /v3/streams/channels/{channel_id}/alerts | List alerts for given channel id
[**list_channels**](ChannelsApi.md#list_channels) | **GET** /v3/streams/channels | List channels.
[**update_channel**](ChannelsApi.md#update_channel) | **PUT** /v3/streams/channels/{channel_id} | Update a channel
[**update_status**](ChannelsApi.md#update_status) | **POST** /v3/streams/channels/{channel_id} | Update channel status



## create_channels

> models::ListChannels200Response create_channels(new_channel)
Create channels.

Create channels.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**new_channel** | [**NewChannel**](NewChannel.md) |  | [required] |

### Return type

[**models::ListChannels200Response**](list_channels_200_response.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_channel

> models::GetChannel200Response delete_channel(channel_id)
Delete a channel

Delete a channel

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**channel_id** | **String** | Unique channel id | [required] |

### Return type

[**models::GetChannel200Response**](get_channel_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **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_channel

> models::GetChannel200Response get_channel(channel_id)
Get channels details

Get details of a specific channel by its id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**channel_id** | **String** | Unique channel id | [required] |

### Return type

[**models::GetChannel200Response**](get_channel_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **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_alerts

> models::ListAlerts200Response list_alerts(channel_id)
List alerts for given channel id

Get details of a specific channel by its id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**channel_id** | **String** | Unique channel id | [required] |

### Return type

[**models::ListAlerts200Response**](list_alerts_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **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_channels

> models::ListChannels200Response list_channels(query, limit, skip)
List channels.

List channels.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**query** | Option<**String**> | a formated query string for channel. |  |
**limit** | Option<**i32**> | limit the number of records returned. |  |
**skip** | Option<**i32**> | index (skip) to start list. |  |

### Return type

[**models::ListChannels200Response**](list_channels_200_response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **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_channel

> models::GetChannel200Response update_channel(channel_id, update_channel)
Update a channel

Update a channel

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**channel_id** | **String** | Unique channel id | [required] |
**update_channel** | [**UpdateChannel**](UpdateChannel.md) |  | [required] |

### Return type

[**models::GetChannel200Response**](get_channel_200_response.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_status

> models::GetChannel200Response update_status(channel_id, update_channel_status)
Update channel status

Update channel status

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**channel_id** | **String** | Unique channel id | [required] |
**update_channel_status** | [**UpdateChannelStatus**](UpdateChannelStatus.md) |  | [required] |

### Return type

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