#[non_exhaustive]pub struct SearchResourcesInputBuilder { /* private fields */ }
Expand description
A builder for SearchResourcesInput
.
Implementations§
Source§impl SearchResourcesInputBuilder
impl SearchResourcesInputBuilder
Sourcepub fn authentication_token(self, input: impl Into<String>) -> Self
pub fn authentication_token(self, input: impl Into<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn set_authentication_token(self, input: Option<String>) -> Self
pub fn set_authentication_token(self, input: Option<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn get_authentication_token(&self) -> &Option<String>
pub fn get_authentication_token(&self) -> &Option<String>
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn query_text(self, input: impl Into<String>) -> Self
pub fn query_text(self, input: impl Into<String>) -> Self
The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
Sourcepub fn set_query_text(self, input: Option<String>) -> Self
pub fn set_query_text(self, input: Option<String>) -> Self
The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
Sourcepub fn get_query_text(&self) -> &Option<String>
pub fn get_query_text(&self) -> &Option<String>
The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
Sourcepub fn query_scopes(self, input: SearchQueryScopeType) -> Self
pub fn query_scopes(self, input: SearchQueryScopeType) -> Self
Appends an item to query_scopes
.
To override the contents of this collection use set_query_scopes
.
Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
Sourcepub fn set_query_scopes(self, input: Option<Vec<SearchQueryScopeType>>) -> Self
pub fn set_query_scopes(self, input: Option<Vec<SearchQueryScopeType>>) -> Self
Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
Sourcepub fn get_query_scopes(&self) -> &Option<Vec<SearchQueryScopeType>>
pub fn get_query_scopes(&self) -> &Option<Vec<SearchQueryScopeType>>
Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
Sourcepub fn organization_id(self, input: impl Into<String>) -> Self
pub fn organization_id(self, input: impl Into<String>) -> Self
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
Sourcepub fn set_organization_id(self, input: Option<String>) -> Self
pub fn set_organization_id(self, input: Option<String>) -> Self
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
Sourcepub fn get_organization_id(&self) -> &Option<String>
pub fn get_organization_id(&self) -> &Option<String>
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
Sourcepub fn additional_response_fields(
self,
input: AdditionalResponseFieldType,
) -> Self
pub fn additional_response_fields( self, input: AdditionalResponseFieldType, ) -> Self
Appends an item to additional_response_fields
.
To override the contents of this collection use set_additional_response_fields
.
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
Sourcepub fn set_additional_response_fields(
self,
input: Option<Vec<AdditionalResponseFieldType>>,
) -> Self
pub fn set_additional_response_fields( self, input: Option<Vec<AdditionalResponseFieldType>>, ) -> Self
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
Sourcepub fn get_additional_response_fields(
&self,
) -> &Option<Vec<AdditionalResponseFieldType>>
pub fn get_additional_response_fields( &self, ) -> &Option<Vec<AdditionalResponseFieldType>>
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
Sourcepub fn set_filters(self, input: Option<Filters>) -> Self
pub fn set_filters(self, input: Option<Filters>) -> Self
Filters results based on entity metadata.
Sourcepub fn get_filters(&self) -> &Option<Filters>
pub fn get_filters(&self) -> &Option<Filters>
Filters results based on entity metadata.
Sourcepub fn order_by(self, input: SearchSortResult) -> Self
pub fn order_by(self, input: SearchSortResult) -> Self
Appends an item to order_by
.
To override the contents of this collection use set_order_by
.
Order by results in one or more categories.
Sourcepub fn set_order_by(self, input: Option<Vec<SearchSortResult>>) -> Self
pub fn set_order_by(self, input: Option<Vec<SearchSortResult>>) -> Self
Order by results in one or more categories.
Sourcepub fn get_order_by(&self) -> &Option<Vec<SearchSortResult>>
pub fn get_order_by(&self) -> &Option<Vec<SearchSortResult>>
Order by results in one or more categories.
Sourcepub fn set_marker(self, input: Option<String>) -> Self
pub fn set_marker(self, input: Option<String>) -> Self
The marker for the next set of results.
Sourcepub fn get_marker(&self) -> &Option<String>
pub fn get_marker(&self) -> &Option<String>
The marker for the next set of results.
Sourcepub fn build(self) -> Result<SearchResourcesInput, BuildError>
pub fn build(self) -> Result<SearchResourcesInput, BuildError>
Consumes the builder and constructs a SearchResourcesInput
.
Source§impl SearchResourcesInputBuilder
impl SearchResourcesInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<SearchResourcesOutput, SdkError<SearchResourcesError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<SearchResourcesOutput, SdkError<SearchResourcesError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for SearchResourcesInputBuilder
impl Clone for SearchResourcesInputBuilder
Source§fn clone(&self) -> SearchResourcesInputBuilder
fn clone(&self) -> SearchResourcesInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SearchResourcesInputBuilder
impl Debug for SearchResourcesInputBuilder
Source§impl Default for SearchResourcesInputBuilder
impl Default for SearchResourcesInputBuilder
Source§fn default() -> SearchResourcesInputBuilder
fn default() -> SearchResourcesInputBuilder
impl StructuralPartialEq for SearchResourcesInputBuilder
Auto Trait Implementations§
impl Freeze for SearchResourcesInputBuilder
impl RefUnwindSafe for SearchResourcesInputBuilder
impl Send for SearchResourcesInputBuilder
impl Sync for SearchResourcesInputBuilder
impl Unpin for SearchResourcesInputBuilder
impl UnwindSafe for SearchResourcesInputBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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);