Struct aws_sdk_alexaforbusiness::operation::search_users::builders::SearchUsersFluentBuilder
source ยท pub struct SearchUsersFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SearchUsers
.
Searches users and lists the ones that meet a set of filter and sort criteria.
Implementationsยง
sourceยงimpl SearchUsersFluentBuilder
impl SearchUsersFluentBuilder
sourcepub fn as_input(&self) -> &SearchUsersInputBuilder
pub fn as_input(&self) -> &SearchUsersInputBuilder
Access the SearchUsers as a reference.
sourcepub async fn send(
self
) -> Result<SearchUsersOutput, SdkError<SearchUsersError, HttpResponse>>
pub async fn send( self ) -> Result<SearchUsersOutput, SdkError<SearchUsersError, 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<SearchUsersOutput, SearchUsersError, Self>
pub fn customize( self ) -> CustomizableOperation<SearchUsersOutput, SearchUsersError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> SearchUsersPaginator
pub fn into_paginator(self) -> SearchUsersPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults
. Required.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults
. Required.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults
. Required.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to include in the response. If more results exist than the specified MaxResults
value, a token is included in the response so that the remaining results can be retrieved. Required.
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 include in the response. If more results exist than the specified MaxResults
value, a token is included in the response so that the remaining results can be retrieved. Required.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to include in the response. If more results exist than the specified MaxResults
value, a token is included in the response so that the remaining results can be retrieved. Required.
sourcepub fn filters(self, input: Filter) -> Self
pub fn filters(self, input: Filter) -> Self
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
sourcepub fn get_filters(&self) -> &Option<Vec<Filter>>
pub fn get_filters(&self) -> &Option<Vec<Filter>>
The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
sourcepub fn sort_criteria(self, input: Sort) -> Self
pub fn sort_criteria(self, input: Sort) -> Self
Appends an item to SortCriteria
.
To override the contents of this collection use set_sort_criteria
.
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
sourcepub fn set_sort_criteria(self, input: Option<Vec<Sort>>) -> Self
pub fn set_sort_criteria(self, input: Option<Vec<Sort>>) -> Self
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
sourcepub fn get_sort_criteria(&self) -> &Option<Vec<Sort>>
pub fn get_sort_criteria(&self) -> &Option<Vec<Sort>>
The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
Trait Implementationsยง
sourceยงimpl Clone for SearchUsersFluentBuilder
impl Clone for SearchUsersFluentBuilder
sourceยงfn clone(&self) -> SearchUsersFluentBuilder
fn clone(&self) -> SearchUsersFluentBuilder
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 SearchUsersFluentBuilder
impl !RefUnwindSafe for SearchUsersFluentBuilder
impl Send for SearchUsersFluentBuilder
impl Sync for SearchUsersFluentBuilder
impl Unpin for SearchUsersFluentBuilder
impl !UnwindSafe for SearchUsersFluentBuilder
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> 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 more