pub struct SearchCasesFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to SearchCases.
Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.
For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.
Implementations§
Source§impl SearchCasesFluentBuilder
impl SearchCasesFluentBuilder
Sourcepub fn as_input(&self) -> &SearchCasesInputBuilder
pub fn as_input(&self) -> &SearchCasesInputBuilder
Access the SearchCases as a reference.
Sourcepub async fn send(
self,
) -> Result<SearchCasesOutput, SdkError<SearchCasesError, HttpResponse>>
pub async fn send( self, ) -> Result<SearchCasesOutput, SdkError<SearchCasesError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SearchCasesOutput, SearchCasesError, Self>
pub fn customize( self, ) -> CustomizableOperation<SearchCasesOutput, SearchCasesError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> SearchCasesPaginator
pub fn into_paginator(self) -> SearchCasesPaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a PaginationStream.
Sourcepub fn domain_id(self, input: impl Into<String>) -> Self
pub fn domain_id(self, input: impl Into<String>) -> Self
The unique identifier of the Cases domain.
Sourcepub fn set_domain_id(self, input: Option<String>) -> Self
pub fn set_domain_id(self, input: Option<String>) -> Self
The unique identifier of the Cases domain.
Sourcepub fn get_domain_id(&self) -> &Option<String>
pub fn get_domain_id(&self) -> &Option<String>
The unique identifier of the Cases domain.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Sourcepub fn search_term(self, input: impl Into<String>) -> Self
pub fn search_term(self, input: impl Into<String>) -> Self
A word or phrase used to perform a quick search.
Sourcepub fn set_search_term(self, input: Option<String>) -> Self
pub fn set_search_term(self, input: Option<String>) -> Self
A word or phrase used to perform a quick search.
Sourcepub fn get_search_term(&self) -> &Option<String>
pub fn get_search_term(&self) -> &Option<String>
A word or phrase used to perform a quick search.
Sourcepub fn filter(self, input: CaseFilter) -> Self
pub fn filter(self, input: CaseFilter) -> Self
A list of filter objects.
Sourcepub fn set_filter(self, input: Option<CaseFilter>) -> Self
pub fn set_filter(self, input: Option<CaseFilter>) -> Self
A list of filter objects.
Sourcepub fn get_filter(&self) -> &Option<CaseFilter>
pub fn get_filter(&self) -> &Option<CaseFilter>
A list of filter objects.
Sourcepub fn sorts(self, input: Sort) -> Self
pub fn sorts(self, input: Sort) -> Self
Appends an item to sorts.
To override the contents of this collection use set_sorts.
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
Sourcepub fn set_sorts(self, input: Option<Vec<Sort>>) -> Self
pub fn set_sorts(self, input: Option<Vec<Sort>>) -> Self
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
Sourcepub fn get_sorts(&self) -> &Option<Vec<Sort>>
pub fn get_sorts(&self) -> &Option<Vec<Sort>>
A list of sorts where each sort specifies a field and their sort order to be applied to the results.
Sourcepub fn fields(self, input: FieldIdentifier) -> Self
pub fn fields(self, input: FieldIdentifier) -> Self
Appends an item to fields.
To override the contents of this collection use set_fields.
The list of field identifiers to be returned as part of the response.
Sourcepub fn set_fields(self, input: Option<Vec<FieldIdentifier>>) -> Self
pub fn set_fields(self, input: Option<Vec<FieldIdentifier>>) -> Self
The list of field identifiers to be returned as part of the response.
Sourcepub fn get_fields(&self) -> &Option<Vec<FieldIdentifier>>
pub fn get_fields(&self) -> &Option<Vec<FieldIdentifier>>
The list of field identifiers to be returned as part of the response.
Trait Implementations§
Source§impl Clone for SearchCasesFluentBuilder
impl Clone for SearchCasesFluentBuilder
Source§fn clone(&self) -> SearchCasesFluentBuilder
fn clone(&self) -> SearchCasesFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for SearchCasesFluentBuilder
impl !RefUnwindSafe for SearchCasesFluentBuilder
impl Send for SearchCasesFluentBuilder
impl Sync for SearchCasesFluentBuilder
impl Unpin for SearchCasesFluentBuilder
impl !UnwindSafe for SearchCasesFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightBlack.
§Example
println!("{}", value.bright_black());Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightGreen.
§Example
println!("{}", value.bright_green());Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightYellow.
§Example
println!("{}", value.bright_yellow());Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.bright_magenta());Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self with the
fg()
set to
Color::BrightWhite.
§Example
println!("{}", value.bright_white());Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlack.
§Example
println!("{}", value.on_bright_black());Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightGreen.
§Example
println!("{}", value.on_bright_green());Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightYellow.
§Example
println!("{}", value.on_bright_yellow());Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightBlue.
§Example
println!("{}", value.on_bright_blue());Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightMagenta.
§Example
println!("{}", value.on_bright_magenta());Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightCyan.
§Example
println!("{}", value.on_bright_cyan());Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self with the
bg()
set to
Color::BrightWhite.
§Example
println!("{}", value.on_bright_white());Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::Underline.
§Example
println!("{}", value.underline());Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self with the
attr()
set to
Attribute::RapidBlink.
§Example
println!("{}", value.rapid_blink());Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);