1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetDocumentationParts`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`rest_api_id(impl Into<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::rest_api_id) / [`set_rest_api_id(Option<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_rest_api_id):<br>required: **true**<br><p>The string identifier of the associated RestApi.</p><br>
    ///   - [`r#type(DocumentationPartType)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::type) / [`set_type(Option<DocumentationPartType>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_type):<br>required: **false**<br><p>The type of API entities of the to-be-retrieved documentation parts. </p><br>
    ///   - [`name_query(impl Into<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::name_query) / [`set_name_query(Option<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_name_query):<br>required: **false**<br><p>The name of API entities of the to-be-retrieved documentation parts.</p><br>
    ///   - [`path(impl Into<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::path) / [`set_path(Option<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_path):<br>required: **false**<br><p>The path of API entities of the to-be-retrieved documentation parts.</p><br>
    ///   - [`position(impl Into<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::position) / [`set_position(Option<String>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_position):<br>required: **false**<br><p>The current pagination position in the paged result set.</p><br>
    ///   - [`limit(i32)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p><br>
    ///   - [`location_status(LocationStatusType)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::location_status) / [`set_location_status(Option<LocationStatusType>)`](crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::set_location_status):<br>required: **false**<br><p>The status of the API documentation parts to retrieve. Valid values are <code>DOCUMENTED</code> for retrieving DocumentationPart resources with content and <code>UNDOCUMENTED</code> for DocumentationPart resources without content.</p><br>
    /// - On success, responds with [`GetDocumentationPartsOutput`](crate::operation::get_documentation_parts::GetDocumentationPartsOutput) with field(s):
    ///   - [`items(Option<Vec::<DocumentationPart>>)`](crate::operation::get_documentation_parts::GetDocumentationPartsOutput::items): <p>The current page of elements from this collection.</p>
    ///   - [`position(Option<String>)`](crate::operation::get_documentation_parts::GetDocumentationPartsOutput::position): <p>The current pagination position in the paged result set.</p>
    /// - On failure, responds with [`SdkError<GetDocumentationPartsError>`](crate::operation::get_documentation_parts::GetDocumentationPartsError)
    pub fn get_documentation_parts(&self) -> crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder {
        crate::operation::get_documentation_parts::builders::GetDocumentationPartsFluentBuilder::new(self.handle.clone())
    }
}