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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct QueryLineageInput {
/// <p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>
pub start_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>
pub direction: ::std::option::Option<crate::types::Direction>,
/// <p>Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.</p>
pub include_edges: ::std::option::Option<bool>,
/// <p>A set of filtering parameters that allow you to specify which entities should be returned.</p>
/// <ul>
/// <li>
/// <p>Properties - Key-value pairs to match on the lineage entities' properties.</p></li>
/// <li>
/// <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p></li>
/// <li>
/// <p>CreatedBefore - Filter entities created before this date.</p></li>
/// <li>
/// <p>ModifiedBefore - Filter entities modified before this date.</p></li>
/// <li>
/// <p>ModifiedAfter - Filter entities modified after this date.</p></li>
/// </ul>
pub filters: ::std::option::Option<crate::types::QueryFilters>,
/// <p>The maximum depth in lineage relationships from the <code>StartArns</code> that are traversed. Depth is a measure of the number of <code>Associations</code> from the <code>StartArn</code> entity to the matched results.</p>
pub max_depth: ::std::option::Option<i32>,
/// <p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub next_token: ::std::option::Option<::std::string::String>,
}
impl QueryLineageInput {
/// <p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.start_arns.is_none()`.
pub fn start_arns(&self) -> &[::std::string::String] {
self.start_arns.as_deref().unwrap_or_default()
}
/// <p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>
pub fn direction(&self) -> ::std::option::Option<&crate::types::Direction> {
self.direction.as_ref()
}
/// <p>Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.</p>
pub fn include_edges(&self) -> ::std::option::Option<bool> {
self.include_edges
}
/// <p>A set of filtering parameters that allow you to specify which entities should be returned.</p>
/// <ul>
/// <li>
/// <p>Properties - Key-value pairs to match on the lineage entities' properties.</p></li>
/// <li>
/// <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p></li>
/// <li>
/// <p>CreatedBefore - Filter entities created before this date.</p></li>
/// <li>
/// <p>ModifiedBefore - Filter entities modified before this date.</p></li>
/// <li>
/// <p>ModifiedAfter - Filter entities modified after this date.</p></li>
/// </ul>
pub fn filters(&self) -> ::std::option::Option<&crate::types::QueryFilters> {
self.filters.as_ref()
}
/// <p>The maximum depth in lineage relationships from the <code>StartArns</code> that are traversed. Depth is a measure of the number of <code>Associations</code> from the <code>StartArn</code> entity to the matched results.</p>
pub fn max_depth(&self) -> ::std::option::Option<i32> {
self.max_depth
}
/// <p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
}
impl QueryLineageInput {
/// Creates a new builder-style object to manufacture [`QueryLineageInput`](crate::operation::query_lineage::QueryLineageInput).
pub fn builder() -> crate::operation::query_lineage::builders::QueryLineageInputBuilder {
crate::operation::query_lineage::builders::QueryLineageInputBuilder::default()
}
}
/// A builder for [`QueryLineageInput`](crate::operation::query_lineage::QueryLineageInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct QueryLineageInputBuilder {
pub(crate) start_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) direction: ::std::option::Option<crate::types::Direction>,
pub(crate) include_edges: ::std::option::Option<bool>,
pub(crate) filters: ::std::option::Option<crate::types::QueryFilters>,
pub(crate) max_depth: ::std::option::Option<i32>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl QueryLineageInputBuilder {
/// Appends an item to `start_arns`.
///
/// To override the contents of this collection use [`set_start_arns`](Self::set_start_arns).
///
/// <p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>
pub fn start_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.start_arns.unwrap_or_default();
v.push(input.into());
self.start_arns = ::std::option::Option::Some(v);
self
}
/// <p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>
pub fn set_start_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.start_arns = input;
self
}
/// <p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>
pub fn get_start_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.start_arns
}
/// <p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>
pub fn direction(mut self, input: crate::types::Direction) -> Self {
self.direction = ::std::option::Option::Some(input);
self
}
/// <p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>
pub fn set_direction(mut self, input: ::std::option::Option<crate::types::Direction>) -> Self {
self.direction = input;
self
}
/// <p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>
pub fn get_direction(&self) -> &::std::option::Option<crate::types::Direction> {
&self.direction
}
/// <p>Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.</p>
pub fn include_edges(mut self, input: bool) -> Self {
self.include_edges = ::std::option::Option::Some(input);
self
}
/// <p>Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.</p>
pub fn set_include_edges(mut self, input: ::std::option::Option<bool>) -> Self {
self.include_edges = input;
self
}
/// <p>Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.</p>
pub fn get_include_edges(&self) -> &::std::option::Option<bool> {
&self.include_edges
}
/// <p>A set of filtering parameters that allow you to specify which entities should be returned.</p>
/// <ul>
/// <li>
/// <p>Properties - Key-value pairs to match on the lineage entities' properties.</p></li>
/// <li>
/// <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p></li>
/// <li>
/// <p>CreatedBefore - Filter entities created before this date.</p></li>
/// <li>
/// <p>ModifiedBefore - Filter entities modified before this date.</p></li>
/// <li>
/// <p>ModifiedAfter - Filter entities modified after this date.</p></li>
/// </ul>
pub fn filters(mut self, input: crate::types::QueryFilters) -> Self {
self.filters = ::std::option::Option::Some(input);
self
}
/// <p>A set of filtering parameters that allow you to specify which entities should be returned.</p>
/// <ul>
/// <li>
/// <p>Properties - Key-value pairs to match on the lineage entities' properties.</p></li>
/// <li>
/// <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p></li>
/// <li>
/// <p>CreatedBefore - Filter entities created before this date.</p></li>
/// <li>
/// <p>ModifiedBefore - Filter entities modified before this date.</p></li>
/// <li>
/// <p>ModifiedAfter - Filter entities modified after this date.</p></li>
/// </ul>
pub fn set_filters(mut self, input: ::std::option::Option<crate::types::QueryFilters>) -> Self {
self.filters = input;
self
}
/// <p>A set of filtering parameters that allow you to specify which entities should be returned.</p>
/// <ul>
/// <li>
/// <p>Properties - Key-value pairs to match on the lineage entities' properties.</p></li>
/// <li>
/// <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p></li>
/// <li>
/// <p>CreatedBefore - Filter entities created before this date.</p></li>
/// <li>
/// <p>ModifiedBefore - Filter entities modified before this date.</p></li>
/// <li>
/// <p>ModifiedAfter - Filter entities modified after this date.</p></li>
/// </ul>
pub fn get_filters(&self) -> &::std::option::Option<crate::types::QueryFilters> {
&self.filters
}
/// <p>The maximum depth in lineage relationships from the <code>StartArns</code> that are traversed. Depth is a measure of the number of <code>Associations</code> from the <code>StartArn</code> entity to the matched results.</p>
pub fn max_depth(mut self, input: i32) -> Self {
self.max_depth = ::std::option::Option::Some(input);
self
}
/// <p>The maximum depth in lineage relationships from the <code>StartArns</code> that are traversed. Depth is a measure of the number of <code>Associations</code> from the <code>StartArn</code> entity to the matched results.</p>
pub fn set_max_depth(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_depth = input;
self
}
/// <p>The maximum depth in lineage relationships from the <code>StartArns</code> that are traversed. Depth is a measure of the number of <code>Associations</code> from the <code>StartArn</code> entity to the matched results.</p>
pub fn get_max_depth(&self) -> &::std::option::Option<i32> {
&self.max_depth
}
/// <p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.next_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// Consumes the builder and constructs a [`QueryLineageInput`](crate::operation::query_lineage::QueryLineageInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::query_lineage::QueryLineageInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::query_lineage::QueryLineageInput {
start_arns: self.start_arns,
direction: self.direction,
include_edges: self.include_edges,
filters: self.filters,
max_depth: self.max_depth,
max_results: self.max_results,
next_token: self.next_token,
})
}
}