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
// @generated — do not edit; run `cargo run -p nifi-openapi-gen`
use crate::NifiClient;
use crate::NifiError;
pub struct ProvenanceApi<'a> {
pub(crate) client: &'a NifiClient,
}
#[allow(
private_interfaces,
clippy::too_many_arguments,
clippy::vec_init_then_push
)]
impl<'a> ProvenanceApi<'a> {
/// Submits a provenance query
///
/// Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.
///
/// Calls `POST /nifi-api/provenance`.
///
/// # Parameters
/// - `body`: The provenance query details.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// - `Read - /provenance`
/// - `Read - /data/{component-type}/{uuid}`
pub async fn submit_provenance_request(
&self,
body: &crate::v2_8_0::types::ProvenanceEntity,
) -> Result<crate::v2_8_0::types::ProvenanceDto, NifiError> {
let e: crate::v2_8_0::types::ProvenanceEntity =
self.client.post("/provenance", body).await?;
Ok(e.provenance)
}
/// Submits a lineage query
///
/// Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.
///
/// Calls `POST /nifi-api/provenance/lineage`.
///
/// # Parameters
/// - `body`: The lineage query details.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `404`: The specified resource could not be found.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// - `Read - /provenance`
/// - `Read - /data/{component-type}/{uuid}`
pub async fn submit_lineage_request(
&self,
body: &crate::v2_8_0::types::LineageEntity,
) -> Result<crate::v2_8_0::types::LineageDto, NifiError> {
let e: crate::v2_8_0::types::LineageEntity =
self.client.post("/provenance/lineage", body).await?;
Ok(e.lineage)
}
/// Deletes a lineage query
///
/// Calls `DELETE /nifi-api/provenance/lineage/{id}`.
///
/// # Parameters
/// - `id`: The id of the lineage query.
/// - `cluster_node_id`: The id of the node where this query exists if clustered.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `404`: The specified resource could not be found.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// Requires `Read - /provenance`.
pub async fn delete_lineage(
&self,
id: &str,
cluster_node_id: Option<&str>,
) -> Result<crate::v2_8_0::types::LineageDto, NifiError> {
let mut query: Vec<(&str, String)> = vec![];
if let Some(v) = cluster_node_id {
query.push(("clusterNodeId", v.to_string()));
}
let e: crate::v2_8_0::types::LineageEntity = self
.client
.delete_returning_with_query(&format!("/provenance/lineage/{id}"), &query)
.await?;
Ok(e.lineage)
}
/// Gets a lineage query
///
/// Calls `GET /nifi-api/provenance/lineage/{id}`.
///
/// # Parameters
/// - `id`: The id of the lineage query.
/// - `cluster_node_id`: The id of the node where this query exists if clustered.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `404`: The specified resource could not be found.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// - `Read - /provenance`
/// - `Read - /data/{component-type}/{uuid}`
pub async fn get_lineage(
&self,
id: &str,
cluster_node_id: Option<&str>,
) -> Result<crate::v2_8_0::types::LineageDto, NifiError> {
let mut query: Vec<(&str, String)> = vec![];
if let Some(v) = cluster_node_id {
query.push(("clusterNodeId", v.to_string()));
}
let e: crate::v2_8_0::types::LineageEntity = self
.client
.get_with_query(&format!("/provenance/lineage/{id}"), &query)
.await?;
Ok(e.lineage)
}
/// Gets the searchable attributes for provenance events
///
/// Calls `GET /nifi-api/provenance/search-options`.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// Requires `Read - /provenance`.
pub async fn get_search_options(
&self,
) -> Result<crate::v2_8_0::types::ProvenanceOptionsDto, NifiError> {
let e: crate::v2_8_0::types::ProvenanceOptionsEntity =
self.client.get("/provenance/search-options").await?;
Ok(e.provenance_options)
}
/// Deletes a provenance query
///
/// Calls `DELETE /nifi-api/provenance/{id}`.
///
/// # Parameters
/// - `id`: The id of the provenance query.
/// - `cluster_node_id`: The id of the node where this query exists if clustered.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `404`: The specified resource could not be found.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// Requires `Read - /provenance`.
pub async fn delete_provenance(
&self,
id: &str,
cluster_node_id: Option<&str>,
) -> Result<crate::v2_8_0::types::ProvenanceDto, NifiError> {
let mut query: Vec<(&str, String)> = vec![];
if let Some(v) = cluster_node_id {
query.push(("clusterNodeId", v.to_string()));
}
let e: crate::v2_8_0::types::ProvenanceEntity = self
.client
.delete_returning_with_query(&format!("/provenance/{id}"), &query)
.await?;
Ok(e.provenance)
}
/// Gets a provenance query
///
/// Calls `GET /nifi-api/provenance/{id}`.
///
/// # Parameters
/// - `id`: The id of the provenance query.
/// - `cluster_node_id`: The id of the node where this query exists if clustered.
/// - `summarize`: Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.
/// - `incremental_results`: Whether or not to summarize provenance events returned. This property is false by default.
///
/// # Errors
/// - `400`: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
/// - `401`: Client could not be authenticated.
/// - `403`: Client is not authorized to make this request.
/// - `404`: The specified resource could not be found.
/// - `409`: The request was valid but NiFi was not in the appropriate state to process it.
///
/// # Permissions
/// - `Read - /provenance`
/// - `Read - /data/{component-type}/{uuid}`
pub async fn get_provenance(
&self,
id: &str,
cluster_node_id: Option<&str>,
summarize: Option<bool>,
incremental_results: Option<bool>,
) -> Result<crate::v2_8_0::types::ProvenanceDto, NifiError> {
let mut query: Vec<(&str, String)> = vec![];
if let Some(v) = cluster_node_id {
query.push(("clusterNodeId", v.to_string()));
}
if let Some(v) = summarize {
query.push(("summarize", v.to_string()));
}
if let Some(v) = incremental_results {
query.push(("incrementalResults", v.to_string()));
}
let e: crate::v2_8_0::types::ProvenanceEntity = self
.client
.get_with_query(&format!("/provenance/{id}"), &query)
.await?;
Ok(e.provenance)
}
}