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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>A document in an index.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Document {
/// <p>A identifier of the document in the index.</p>
/// <p>Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>
pub id: ::std::string::String,
/// <p>The title of the document.</p>
pub title: ::std::option::Option<::std::string::String>,
/// <p>The contents of the document.</p>
/// <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>
pub blob: ::std::option::Option<::aws_smithy_types::Blob>,
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub s3_path: ::std::option::Option<crate::types::S3Path>,
/// <p>Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.</p>
/// <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.</p>
pub attributes: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttribute>>,
/// <p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>
pub access_control_list: ::std::option::Option<::std::vec::Vec<crate::types::Principal>>,
/// <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</p>
pub hierarchical_access_control_list: ::std::option::Option<::std::vec::Vec<crate::types::HierarchicalPrincipal>>,
/// <p>The file type of the document in the <code>Blob</code> field.</p>
/// <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the <code>HTML</code> start and closing tags (<code>content</code>) around the content.</p>
pub content_type: ::std::option::Option<crate::types::ContentType>,
/// <p>The identifier of the access control configuration that you want to apply to the document.</p>
pub access_control_configuration_id: ::std::option::Option<::std::string::String>,
}
impl Document {
/// <p>A identifier of the document in the index.</p>
/// <p>Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>
pub fn id(&self) -> &str {
use std::ops::Deref;
self.id.deref()
}
/// <p>The title of the document.</p>
pub fn title(&self) -> ::std::option::Option<&str> {
self.title.as_deref()
}
/// <p>The contents of the document.</p>
/// <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>
pub fn blob(&self) -> ::std::option::Option<&::aws_smithy_types::Blob> {
self.blob.as_ref()
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn s3_path(&self) -> ::std::option::Option<&crate::types::S3Path> {
self.s3_path.as_ref()
}
/// <p>Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.</p>
/// <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.</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 `.attributes.is_none()`.
pub fn attributes(&self) -> &[crate::types::DocumentAttribute] {
self.attributes.as_deref().unwrap_or_default()
}
/// <p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</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 `.access_control_list.is_none()`.
pub fn access_control_list(&self) -> &[crate::types::Principal] {
self.access_control_list.as_deref().unwrap_or_default()
}
/// <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</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 `.hierarchical_access_control_list.is_none()`.
pub fn hierarchical_access_control_list(&self) -> &[crate::types::HierarchicalPrincipal] {
self.hierarchical_access_control_list.as_deref().unwrap_or_default()
}
/// <p>The file type of the document in the <code>Blob</code> field.</p>
/// <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the <code>HTML</code> start and closing tags (<code>content</code>) around the content.</p>
pub fn content_type(&self) -> ::std::option::Option<&crate::types::ContentType> {
self.content_type.as_ref()
}
/// <p>The identifier of the access control configuration that you want to apply to the document.</p>
pub fn access_control_configuration_id(&self) -> ::std::option::Option<&str> {
self.access_control_configuration_id.as_deref()
}
}
impl Document {
/// Creates a new builder-style object to manufacture [`Document`](crate::types::Document).
pub fn builder() -> crate::types::builders::DocumentBuilder {
crate::types::builders::DocumentBuilder::default()
}
}
/// A builder for [`Document`](crate::types::Document).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DocumentBuilder {
pub(crate) id: ::std::option::Option<::std::string::String>,
pub(crate) title: ::std::option::Option<::std::string::String>,
pub(crate) blob: ::std::option::Option<::aws_smithy_types::Blob>,
pub(crate) s3_path: ::std::option::Option<crate::types::S3Path>,
pub(crate) attributes: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttribute>>,
pub(crate) access_control_list: ::std::option::Option<::std::vec::Vec<crate::types::Principal>>,
pub(crate) hierarchical_access_control_list: ::std::option::Option<::std::vec::Vec<crate::types::HierarchicalPrincipal>>,
pub(crate) content_type: ::std::option::Option<crate::types::ContentType>,
pub(crate) access_control_configuration_id: ::std::option::Option<::std::string::String>,
}
impl DocumentBuilder {
/// <p>A identifier of the document in the index.</p>
/// <p>Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>
/// This field is required.
pub fn id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.id = ::std::option::Option::Some(input.into());
self
}
/// <p>A identifier of the document in the index.</p>
/// <p>Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>
pub fn set_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.id = input;
self
}
/// <p>A identifier of the document in the index.</p>
/// <p>Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa. You can delete a data source and then use the <code>BatchPutDocument</code> API to index the same documents, or vice versa.</p>
pub fn get_id(&self) -> &::std::option::Option<::std::string::String> {
&self.id
}
/// <p>The title of the document.</p>
pub fn title(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.title = ::std::option::Option::Some(input.into());
self
}
/// <p>The title of the document.</p>
pub fn set_title(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.title = input;
self
}
/// <p>The title of the document.</p>
pub fn get_title(&self) -> &::std::option::Option<::std::string::String> {
&self.title
}
/// <p>The contents of the document.</p>
/// <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>
pub fn blob(mut self, input: ::aws_smithy_types::Blob) -> Self {
self.blob = ::std::option::Option::Some(input);
self
}
/// <p>The contents of the document.</p>
/// <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>
pub fn set_blob(mut self, input: ::std::option::Option<::aws_smithy_types::Blob>) -> Self {
self.blob = input;
self
}
/// <p>The contents of the document.</p>
/// <p>Documents passed to the <code>Blob</code> parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.</p>
pub fn get_blob(&self) -> &::std::option::Option<::aws_smithy_types::Blob> {
&self.blob
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn s3_path(mut self, input: crate::types::S3Path) -> Self {
self.s3_path = ::std::option::Option::Some(input);
self
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn set_s3_path(mut self, input: ::std::option::Option<crate::types::S3Path>) -> Self {
self.s3_path = input;
self
}
/// <p>Information required to find a specific file in an Amazon S3 bucket.</p>
pub fn get_s3_path(&self) -> &::std::option::Option<crate::types::S3Path> {
&self.s3_path
}
/// Appends an item to `attributes`.
///
/// To override the contents of this collection use [`set_attributes`](Self::set_attributes).
///
/// <p>Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.</p>
/// <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.</p>
pub fn attributes(mut self, input: crate::types::DocumentAttribute) -> Self {
let mut v = self.attributes.unwrap_or_default();
v.push(input);
self.attributes = ::std::option::Option::Some(v);
self
}
/// <p>Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.</p>
/// <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.</p>
pub fn set_attributes(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentAttribute>>) -> Self {
self.attributes = input;
self
}
/// <p>Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.</p>
/// <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.</p>
pub fn get_attributes(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentAttribute>> {
&self.attributes
}
/// Appends an item to `access_control_list`.
///
/// To override the contents of this collection use [`set_access_control_list`](Self::set_access_control_list).
///
/// <p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>
pub fn access_control_list(mut self, input: crate::types::Principal) -> Self {
let mut v = self.access_control_list.unwrap_or_default();
v.push(input);
self.access_control_list = ::std::option::Option::Some(v);
self
}
/// <p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>
pub fn set_access_control_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Principal>>) -> Self {
self.access_control_list = input;
self
}
/// <p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>
pub fn get_access_control_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Principal>> {
&self.access_control_list
}
/// Appends an item to `hierarchical_access_control_list`.
///
/// To override the contents of this collection use [`set_hierarchical_access_control_list`](Self::set_hierarchical_access_control_list).
///
/// <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</p>
pub fn hierarchical_access_control_list(mut self, input: crate::types::HierarchicalPrincipal) -> Self {
let mut v = self.hierarchical_access_control_list.unwrap_or_default();
v.push(input);
self.hierarchical_access_control_list = ::std::option::Option::Some(v);
self
}
/// <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</p>
pub fn set_hierarchical_access_control_list(
mut self,
input: ::std::option::Option<::std::vec::Vec<crate::types::HierarchicalPrincipal>>,
) -> Self {
self.hierarchical_access_control_list = input;
self
}
/// <p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</p>
pub fn get_hierarchical_access_control_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::HierarchicalPrincipal>> {
&self.hierarchical_access_control_list
}
/// <p>The file type of the document in the <code>Blob</code> field.</p>
/// <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the <code>HTML</code> start and closing tags (<code>content</code>) around the content.</p>
pub fn content_type(mut self, input: crate::types::ContentType) -> Self {
self.content_type = ::std::option::Option::Some(input);
self
}
/// <p>The file type of the document in the <code>Blob</code> field.</p>
/// <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the <code>HTML</code> start and closing tags (<code>content</code>) around the content.</p>
pub fn set_content_type(mut self, input: ::std::option::Option<crate::types::ContentType>) -> Self {
self.content_type = input;
self
}
/// <p>The file type of the document in the <code>Blob</code> field.</p>
/// <p>If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the <code>HTML</code> start and closing tags (<code>content</code>) around the content.</p>
pub fn get_content_type(&self) -> &::std::option::Option<crate::types::ContentType> {
&self.content_type
}
/// <p>The identifier of the access control configuration that you want to apply to the document.</p>
pub fn access_control_configuration_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.access_control_configuration_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the access control configuration that you want to apply to the document.</p>
pub fn set_access_control_configuration_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.access_control_configuration_id = input;
self
}
/// <p>The identifier of the access control configuration that you want to apply to the document.</p>
pub fn get_access_control_configuration_id(&self) -> &::std::option::Option<::std::string::String> {
&self.access_control_configuration_id
}
/// Consumes the builder and constructs a [`Document`](crate::types::Document).
/// This method will fail if any of the following fields are not set:
/// - [`id`](crate::types::builders::DocumentBuilder::id)
pub fn build(self) -> ::std::result::Result<crate::types::Document, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::types::Document {
id: self.id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"id",
"id was not specified but it is required when building Document",
)
})?,
title: self.title,
blob: self.blob,
s3_path: self.s3_path,
attributes: self.attributes,
access_control_list: self.access_control_list,
hierarchical_access_control_list: self.hierarchical_access_control_list,
content_type: self.content_type,
access_control_configuration_id: self.access_control_configuration_id,
})
}
}