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
// 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 GetFindingsInput {
/// <p>The finding attributes used to define a condition to filter the returned findings.</p>
/// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
/// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
pub filters: ::std::option::Option<crate::types::AwsSecurityFindingFilters>,
/// <p>The finding attributes used to sort the list of returned findings.</p>
pub sort_criteria: ::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>>,
/// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
/// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of findings to return.</p>
pub max_results: ::std::option::Option<i32>,
}
impl GetFindingsInput {
/// <p>The finding attributes used to define a condition to filter the returned findings.</p>
/// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
/// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
pub fn filters(&self) -> ::std::option::Option<&crate::types::AwsSecurityFindingFilters> {
self.filters.as_ref()
}
/// <p>The finding attributes used to sort the list of returned findings.</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 `.sort_criteria.is_none()`.
pub fn sort_criteria(&self) -> &[crate::types::SortCriterion] {
self.sort_criteria.as_deref().unwrap_or_default()
}
/// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
/// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of findings to return.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
}
impl GetFindingsInput {
/// Creates a new builder-style object to manufacture [`GetFindingsInput`](crate::operation::get_findings::GetFindingsInput).
pub fn builder() -> crate::operation::get_findings::builders::GetFindingsInputBuilder {
crate::operation::get_findings::builders::GetFindingsInputBuilder::default()
}
}
/// A builder for [`GetFindingsInput`](crate::operation::get_findings::GetFindingsInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetFindingsInputBuilder {
pub(crate) filters: ::std::option::Option<crate::types::AwsSecurityFindingFilters>,
pub(crate) sort_criteria: ::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
}
impl GetFindingsInputBuilder {
/// <p>The finding attributes used to define a condition to filter the returned findings.</p>
/// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
/// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
pub fn filters(mut self, input: crate::types::AwsSecurityFindingFilters) -> Self {
self.filters = ::std::option::Option::Some(input);
self
}
/// <p>The finding attributes used to define a condition to filter the returned findings.</p>
/// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
/// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
pub fn set_filters(mut self, input: ::std::option::Option<crate::types::AwsSecurityFindingFilters>) -> Self {
self.filters = input;
self
}
/// <p>The finding attributes used to define a condition to filter the returned findings.</p>
/// <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>
/// <p>Note that in the available filter fields, <code>WorkflowState</code> is deprecated. To search for a finding based on its workflow status, use <code>WorkflowStatus</code>.</p>
pub fn get_filters(&self) -> &::std::option::Option<crate::types::AwsSecurityFindingFilters> {
&self.filters
}
/// Appends an item to `sort_criteria`.
///
/// To override the contents of this collection use [`set_sort_criteria`](Self::set_sort_criteria).
///
/// <p>The finding attributes used to sort the list of returned findings.</p>
pub fn sort_criteria(mut self, input: crate::types::SortCriterion) -> Self {
let mut v = self.sort_criteria.unwrap_or_default();
v.push(input);
self.sort_criteria = ::std::option::Option::Some(v);
self
}
/// <p>The finding attributes used to sort the list of returned findings.</p>
pub fn set_sort_criteria(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>>) -> Self {
self.sort_criteria = input;
self
}
/// <p>The finding attributes used to sort the list of returned findings.</p>
pub fn get_sort_criteria(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::SortCriterion>> {
&self.sort_criteria
}
/// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
/// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</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 that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
/// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The token that is required for pagination. On your first call to the <code>GetFindings</code> operation, set the value of this parameter to <code>NULL</code>.</p>
/// <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of findings to return.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of findings to return.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of findings to return.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// Consumes the builder and constructs a [`GetFindingsInput`](crate::operation::get_findings::GetFindingsInput).
pub fn build(self) -> ::std::result::Result<crate::operation::get_findings::GetFindingsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_findings::GetFindingsInput {
filters: self.filters,
sort_criteria: self.sort_criteria,
next_token: self.next_token,
max_results: self.max_results,
})
}
}