pub struct SearchFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to Search.
Searches for assets in Amazon DataZone.
Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.
Many search commands in Amazon DataZone are paginated, including search and search-types. When the result set is large, Amazon DataZone returns a nextToken in the response. This token can be used to retrieve the next page of results.
Prerequisites:
-
The --domain-identifier must refer to an existing Amazon DataZone domain.
-
--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.
-
The user must have search permissions in the specified domain.
-
If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys.
-
For paginated results, be prepared to use --next-token to fetch additional pages.
Implementations§
Source§impl SearchFluentBuilder
impl SearchFluentBuilder
Sourcepub fn as_input(&self) -> &SearchInputBuilder
pub fn as_input(&self) -> &SearchInputBuilder
Access the Search as a reference.
Sourcepub async fn send(
self,
) -> Result<SearchOutput, SdkError<SearchError, HttpResponse>>
pub async fn send( self, ) -> Result<SearchOutput, SdkError<SearchError, 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<SearchOutput, SearchError, Self>
pub fn customize(self) -> CustomizableOperation<SearchOutput, SearchError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> SearchPaginator
pub fn into_paginator(self) -> SearchPaginator
Create a paginator for this request
Paginators are used by calling send().await which returns a PaginationStream.
Sourcepub fn domain_identifier(self, input: impl Into<String>) -> Self
pub fn domain_identifier(self, input: impl Into<String>) -> Self
The identifier of the Amazon DataZone domain.
Sourcepub fn set_domain_identifier(self, input: Option<String>) -> Self
pub fn set_domain_identifier(self, input: Option<String>) -> Self
The identifier of the Amazon DataZone domain.
Sourcepub fn get_domain_identifier(&self) -> &Option<String>
pub fn get_domain_identifier(&self) -> &Option<String>
The identifier of the Amazon DataZone domain.
Sourcepub fn owning_project_identifier(self, input: impl Into<String>) -> Self
pub fn owning_project_identifier(self, input: impl Into<String>) -> Self
The identifier of the owning project specified for the search.
Sourcepub fn set_owning_project_identifier(self, input: Option<String>) -> Self
pub fn set_owning_project_identifier(self, input: Option<String>) -> Self
The identifier of the owning project specified for the search.
Sourcepub fn get_owning_project_identifier(&self) -> &Option<String>
pub fn get_owning_project_identifier(&self) -> &Option<String>
The identifier of the owning project specified for the search.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.
Sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list 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
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
Sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.
Sourcepub fn search_scope(self, input: InventorySearchScope) -> Self
pub fn search_scope(self, input: InventorySearchScope) -> Self
The scope of the search.
Sourcepub fn set_search_scope(self, input: Option<InventorySearchScope>) -> Self
pub fn set_search_scope(self, input: Option<InventorySearchScope>) -> Self
The scope of the search.
Sourcepub fn get_search_scope(&self) -> &Option<InventorySearchScope>
pub fn get_search_scope(&self) -> &Option<InventorySearchScope>
The scope of the search.
Sourcepub fn search_text(self, input: impl Into<String>) -> Self
pub fn search_text(self, input: impl Into<String>) -> Self
Specifies the text for which to search.
Sourcepub fn set_search_text(self, input: Option<String>) -> Self
pub fn set_search_text(self, input: Option<String>) -> Self
Specifies the text for which to search.
Sourcepub fn get_search_text(&self) -> &Option<String>
pub fn get_search_text(&self) -> &Option<String>
Specifies the text for which to search.
Sourcepub fn search_in(self, input: SearchInItem) -> Self
pub fn search_in(self, input: SearchInItem) -> Self
Appends an item to searchIn.
To override the contents of this collection use set_search_in.
The details of the search.
Sourcepub fn set_search_in(self, input: Option<Vec<SearchInItem>>) -> Self
pub fn set_search_in(self, input: Option<Vec<SearchInItem>>) -> Self
The details of the search.
Sourcepub fn get_search_in(&self) -> &Option<Vec<SearchInItem>>
pub fn get_search_in(&self) -> &Option<Vec<SearchInItem>>
The details of the search.
Sourcepub fn filters(self, input: FilterClause) -> Self
pub fn filters(self, input: FilterClause) -> Self
Specifies the search filters.
Sourcepub fn set_filters(self, input: Option<FilterClause>) -> Self
pub fn set_filters(self, input: Option<FilterClause>) -> Self
Specifies the search filters.
Sourcepub fn get_filters(&self) -> &Option<FilterClause>
pub fn get_filters(&self) -> &Option<FilterClause>
Specifies the search filters.
Sourcepub fn sort(self, input: SearchSort) -> Self
pub fn sort(self, input: SearchSort) -> Self
Specifies the way in which the search results are to be sorted.
Sourcepub fn set_sort(self, input: Option<SearchSort>) -> Self
pub fn set_sort(self, input: Option<SearchSort>) -> Self
Specifies the way in which the search results are to be sorted.
Sourcepub fn get_sort(&self) -> &Option<SearchSort>
pub fn get_sort(&self) -> &Option<SearchSort>
Specifies the way in which the search results are to be sorted.
Sourcepub fn additional_attributes(
self,
input: SearchOutputAdditionalAttribute,
) -> Self
pub fn additional_attributes( self, input: SearchOutputAdditionalAttribute, ) -> Self
Appends an item to additionalAttributes.
To override the contents of this collection use set_additional_attributes.
Specifies additional attributes for the Search action.
Sourcepub fn set_additional_attributes(
self,
input: Option<Vec<SearchOutputAdditionalAttribute>>,
) -> Self
pub fn set_additional_attributes( self, input: Option<Vec<SearchOutputAdditionalAttribute>>, ) -> Self
Specifies additional attributes for the Search action.
Sourcepub fn get_additional_attributes(
&self,
) -> &Option<Vec<SearchOutputAdditionalAttribute>>
pub fn get_additional_attributes( &self, ) -> &Option<Vec<SearchOutputAdditionalAttribute>>
Specifies additional attributes for the Search action.
Trait Implementations§
Source§impl Clone for SearchFluentBuilder
impl Clone for SearchFluentBuilder
Source§fn clone(&self) -> SearchFluentBuilder
fn clone(&self) -> SearchFluentBuilder
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 SearchFluentBuilder
impl !RefUnwindSafe for SearchFluentBuilder
impl Send for SearchFluentBuilder
impl Sync for SearchFluentBuilder
impl Unpin for SearchFluentBuilder
impl !UnwindSafe for SearchFluentBuilder
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);