// 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 ListDocumentsInput {
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub document_filter_list: ::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>>,
/// <p>One or more <code>DocumentKeyValuesFilter</code> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub filters: ::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>>,
/// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub next_token: ::std::option::Option<::std::string::String>,
}
impl ListDocumentsInput {
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</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 `.document_filter_list.is_none()`.
pub fn document_filter_list(&self) -> &[crate::types::DocumentFilter] {
self.document_filter_list.as_deref().unwrap_or_default()
}
/// <p>One or more <code>DocumentKeyValuesFilter</code> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
pub fn filters(&self) -> &[crate::types::DocumentKeyValuesFilter] {
self.filters.as_deref().unwrap_or_default()
}
/// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
}
static LISTDOCUMENTSINPUT_MEMBER_DOCUMENT_FILTER_LIST_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts("com.amazonaws.ssm#DocumentFilterList$member", "com.amazonaws.ssm", "DocumentFilterList"),
::aws_smithy_schema::ShapeType::Structure,
"member",
0,
)
.with_xml_name("DocumentFilter");
static LISTDOCUMENTSINPUT_MEMBER_DOCUMENT_FILTER_LIST: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm.synthetic#ListDocumentsInput$DocumentFilterList",
"com.amazonaws.ssm.synthetic",
"ListDocumentsInput",
),
::aws_smithy_schema::ShapeType::List,
"DocumentFilterList",
0,
)
.with_list_member(&LISTDOCUMENTSINPUT_MEMBER_DOCUMENT_FILTER_LIST_MEMBER);
static LISTDOCUMENTSINPUT_MEMBER_FILTERS_MEMBER: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm#DocumentKeyValuesFilterList$member",
"com.amazonaws.ssm",
"DocumentKeyValuesFilterList",
),
::aws_smithy_schema::ShapeType::Structure,
"member",
0,
);
static LISTDOCUMENTSINPUT_MEMBER_FILTERS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm.synthetic#ListDocumentsInput$Filters",
"com.amazonaws.ssm.synthetic",
"ListDocumentsInput",
),
::aws_smithy_schema::ShapeType::List,
"Filters",
1,
)
.with_list_member(&LISTDOCUMENTSINPUT_MEMBER_FILTERS_MEMBER);
static LISTDOCUMENTSINPUT_MEMBER_MAX_RESULTS: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm.synthetic#ListDocumentsInput$MaxResults",
"com.amazonaws.ssm.synthetic",
"ListDocumentsInput",
),
::aws_smithy_schema::ShapeType::Integer,
"MaxResults",
2,
);
static LISTDOCUMENTSINPUT_MEMBER_NEXT_TOKEN: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_member(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm.synthetic#ListDocumentsInput$NextToken",
"com.amazonaws.ssm.synthetic",
"ListDocumentsInput",
),
::aws_smithy_schema::ShapeType::String,
"NextToken",
3,
);
static LISTDOCUMENTSINPUT_SCHEMA: ::aws_smithy_schema::Schema<'static> = ::aws_smithy_schema::Schema::new_struct(
::aws_smithy_schema::ShapeId::from_parts(
"com.amazonaws.ssm.synthetic#ListDocumentsInput",
"com.amazonaws.ssm.synthetic",
"ListDocumentsInput",
),
::aws_smithy_schema::ShapeType::Structure,
&[
&LISTDOCUMENTSINPUT_MEMBER_DOCUMENT_FILTER_LIST,
&LISTDOCUMENTSINPUT_MEMBER_FILTERS,
&LISTDOCUMENTSINPUT_MEMBER_MAX_RESULTS,
&LISTDOCUMENTSINPUT_MEMBER_NEXT_TOKEN,
],
)
.with_payload_hint(::aws_smithy_schema::PayloadHint::NoStructPayload)
.with_original_name("ListDocumentsRequest");
impl ListDocumentsInput {
/// The schema for this shape.
pub const SCHEMA: &'static ::aws_smithy_schema::Schema<'static> = &LISTDOCUMENTSINPUT_SCHEMA;
}
impl ::aws_smithy_schema::serde::SerializableStruct for ListDocumentsInput {
fn schema(&self) -> &::aws_smithy_schema::Schema<'_> {
Self::SCHEMA
}
#[allow(unused_variables, clippy::diverging_sub_expression)]
fn serialize_members(
&self,
ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer,
) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
if let Some(ref val) = self.document_filter_list {
ser.write_list(
&LISTDOCUMENTSINPUT_MEMBER_DOCUMENT_FILTER_LIST,
&|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
for item in val {
ser.write_struct(crate::types::DocumentFilter::SCHEMA, item)?;
}
Ok(())
},
)?;
}
if let Some(ref val) = self.filters {
ser.write_list(
&LISTDOCUMENTSINPUT_MEMBER_FILTERS,
&|ser: &mut dyn ::aws_smithy_schema::serde::ShapeSerializer| {
for item in val {
ser.write_struct(crate::types::DocumentKeyValuesFilter::SCHEMA, item)?;
}
Ok(())
},
)?;
}
if let Some(ref val) = self.max_results {
ser.write_integer(&LISTDOCUMENTSINPUT_MEMBER_MAX_RESULTS, *val)?;
}
if let Some(ref val) = self.next_token {
ser.write_string(&LISTDOCUMENTSINPUT_MEMBER_NEXT_TOKEN, val)?;
}
Ok(())
}
}
impl crate::operation::list_documents::builders::ListDocumentsInputBuilder {
#[allow(
unused_variables,
unreachable_code,
clippy::single_match,
clippy::match_single_binding,
clippy::diverging_sub_expression
)]
pub(crate) fn deserialize_members(
&mut self,
deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
) -> ::std::result::Result<(), ::aws_smithy_schema::serde::SerdeError> {
deserializer.read_struct(&LISTDOCUMENTSINPUT_SCHEMA, &mut |member, deser| {
match member.member_index() {
Some(0) => {
if deser.is_null() {
deser.read_null()?;
} else {
self.document_filter_list = Some({
let mut container = Vec::new();
deser.read_list(member, &mut |deser| {
container.push(crate::types::DocumentFilter::deserialize(deser)?);
Ok(())
})?;
container
});
}
}
Some(1) => {
if deser.is_null() {
deser.read_null()?;
} else {
self.filters = Some({
let mut container = Vec::new();
deser.read_list(member, &mut |deser| {
container.push(crate::types::DocumentKeyValuesFilter::deserialize(deser)?);
Ok(())
})?;
container
});
}
}
Some(2) => {
if deser.is_null() {
deser.read_null()?;
} else {
self.max_results = Some(deser.read_integer(member)?);
}
}
Some(3) => {
if deser.is_null() {
deser.read_null()?;
} else {
self.next_token = Some(deser.read_string(member)?);
}
}
_ => {}
}
Ok(())
})
}
}
impl ListDocumentsInput {
/// Deserializes this structure from a [`ShapeDeserializer`].
pub fn deserialize(
deserializer: &mut dyn ::aws_smithy_schema::serde::ShapeDeserializer,
) -> ::std::result::Result<Self, ::aws_smithy_schema::serde::SerdeError> {
let mut builder = Self::builder();
builder.deserialize_members(deserializer)?;
builder.build().map_err(|e| aws_smithy_schema::serde::SerdeError::custom(e.to_string()))
}
}
impl ListDocumentsInput {
/// Creates a new builder-style object to manufacture [`ListDocumentsInput`](crate::operation::list_documents::ListDocumentsInput).
pub fn builder() -> crate::operation::list_documents::builders::ListDocumentsInputBuilder {
crate::operation::list_documents::builders::ListDocumentsInputBuilder::default()
}
}
/// A builder for [`ListDocumentsInput`](crate::operation::list_documents::ListDocumentsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListDocumentsInputBuilder {
pub(crate) document_filter_list: ::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>>,
pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
}
impl ListDocumentsInputBuilder {
/// Appends an item to `document_filter_list`.
///
/// To override the contents of this collection use [`set_document_filter_list`](Self::set_document_filter_list).
///
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn document_filter_list(mut self, input: crate::types::DocumentFilter) -> Self {
let mut v = self.document_filter_list.unwrap_or_default();
v.push(input);
self.document_filter_list = ::std::option::Option::Some(v);
self
}
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn set_document_filter_list(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>>) -> Self {
self.document_filter_list = input;
self
}
/// <p>This data type is deprecated. Instead, use <code>Filters</code>.</p>
pub fn get_document_filter_list(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentFilter>> {
&self.document_filter_list
}
/// Appends an item to `filters`.
///
/// To override the contents of this collection use [`set_filters`](Self::set_filters).
///
/// <p>One or more <code>DocumentKeyValuesFilter</code> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn filters(mut self, input: crate::types::DocumentKeyValuesFilter) -> Self {
let mut v = self.filters.unwrap_or_default();
v.push(input);
self.filters = ::std::option::Option::Some(v);
self
}
/// <p>One or more <code>DocumentKeyValuesFilter</code> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>>) -> Self {
self.filters = input;
self
}
/// <p>One or more <code>DocumentKeyValuesFilter</code> objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include <code>Owner</code>, <code>Name</code>, <code>PlatformTypes</code>, <code>DocumentType</code>, and <code>TargetType</code>. For example, to return documents you own use <code>Key=Owner,Values=Self</code>. To specify a custom key-value pair, use the format <code>Key=tag:tagName,Values=valueName</code>.</p><note>
/// <p>This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: <code>Key=tag:tagName,Values=valueName1,valueName2</code></p>
/// </note>
pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DocumentKeyValuesFilter>> {
&self.filters
}
/// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</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>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// Consumes the builder and constructs a [`ListDocumentsInput`](crate::operation::list_documents::ListDocumentsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::list_documents::ListDocumentsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::list_documents::ListDocumentsInput {
document_filter_list: self.document_filter_list,
filters: self.filters,
max_results: self.max_results,
next_token: self.next_token,
})
}
}