pub struct SearchListingsFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to SearchListings.
Searches listings in Amazon DataZone.
SearchListings is a powerful capability that enables users to discover and explore published assets 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. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API 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.
SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.
The SearchListings API gives users flexibility in specifying what kind of search is run.
To run a free-text search, the searchText parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the CreateFormType API documentation. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.
To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute __DataZoneGlossaryTerms.
To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.
Implementations§
Source§impl SearchListingsFluentBuilder
impl SearchListingsFluentBuilder
Sourcepub fn as_input(&self) -> &SearchListingsInputBuilder
pub fn as_input(&self) -> &SearchListingsInputBuilder
Access the SearchListings as a reference.
Sourcepub async fn send(
self,
) -> Result<SearchListingsOutput, SdkError<SearchListingsError, HttpResponse>>
pub async fn send( self, ) -> Result<SearchListingsOutput, SdkError<SearchListingsError, 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<SearchListingsOutput, SearchListingsError, Self>
pub fn customize( self, ) -> CustomizableOperation<SearchListingsOutput, SearchListingsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn into_paginator(self) -> SearchListingsPaginator
pub fn into_paginator(self) -> SearchListingsPaginator
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 domain in which to search listings.
Sourcepub fn set_domain_identifier(self, input: Option<String>) -> Self
pub fn set_domain_identifier(self, input: Option<String>) -> Self
The identifier of the domain in which to search listings.
Sourcepub fn get_domain_identifier(&self) -> &Option<String>
pub fn get_domain_identifier(&self) -> &Option<String>
The identifier of the domain in which to search listings.
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 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 SearchListings. 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 SearchListings 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 SearchListings. 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 SearchListings 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 SearchListings. 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 SearchListings 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 SearchListings 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 SearchListings 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 SearchListings to list the next set of results.
Sourcepub fn filters(self, input: FilterClause) -> Self
pub fn filters(self, input: FilterClause) -> Self
Specifies the filters for the search of listings.
Sourcepub fn set_filters(self, input: Option<FilterClause>) -> Self
pub fn set_filters(self, input: Option<FilterClause>) -> Self
Specifies the filters for the search of listings.
Sourcepub fn get_filters(&self) -> &Option<FilterClause>
pub fn get_filters(&self) -> &Option<FilterClause>
Specifies the filters for the search of listings.
Sourcepub fn aggregations(self, input: AggregationListItem) -> Self
pub fn aggregations(self, input: AggregationListItem) -> Self
Appends an item to aggregations.
To override the contents of this collection use set_aggregations.
Enables you to specify one or more attributes to compute and return counts grouped by field values.
Sourcepub fn set_aggregations(self, input: Option<Vec<AggregationListItem>>) -> Self
pub fn set_aggregations(self, input: Option<Vec<AggregationListItem>>) -> Self
Enables you to specify one or more attributes to compute and return counts grouped by field values.
Sourcepub fn get_aggregations(&self) -> &Option<Vec<AggregationListItem>>
pub fn get_aggregations(&self) -> &Option<Vec<AggregationListItem>>
Enables you to specify one or more attributes to compute and return counts grouped by field values.
Sourcepub fn sort(self, input: SearchSort) -> Self
pub fn sort(self, input: SearchSort) -> Self
Specifies the way for sorting the search results.
Sourcepub fn set_sort(self, input: Option<SearchSort>) -> Self
pub fn set_sort(self, input: Option<SearchSort>) -> Self
Specifies the way for sorting the search results.
Sourcepub fn get_sort(&self) -> &Option<SearchSort>
pub fn get_sort(&self) -> &Option<SearchSort>
Specifies the way for sorting the search results.
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.
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.
Sourcepub fn get_additional_attributes(
&self,
) -> &Option<Vec<SearchOutputAdditionalAttribute>>
pub fn get_additional_attributes( &self, ) -> &Option<Vec<SearchOutputAdditionalAttribute>>
Specifies additional attributes for the search.
Trait Implementations§
Source§impl Clone for SearchListingsFluentBuilder
impl Clone for SearchListingsFluentBuilder
Source§fn clone(&self) -> SearchListingsFluentBuilder
fn clone(&self) -> SearchListingsFluentBuilder
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 SearchListingsFluentBuilder
impl !RefUnwindSafe for SearchListingsFluentBuilder
impl Send for SearchListingsFluentBuilder
impl Sync for SearchListingsFluentBuilder
impl Unpin for SearchListingsFluentBuilder
impl !UnwindSafe for SearchListingsFluentBuilder
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);