Struct aws_sdk_workdocs::input::describe_users_input::Builder

pub struct Builder { /* private fields */ }

A builder for DescribeUsersInput.

Implementations

impl Builder

pub fn authentication_token(self, input: impl Into<String>) -> Self

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

pub fn set_authentication_token(self, input: Option<String>) -> Self

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

pub fn organization_id(self, input: impl Into<String>) -> Self

The ID of the organization.

pub fn set_organization_id(self, input: Option<String>) -> Self

The ID of the organization.

pub fn user_ids(self, input: impl Into<String>) -> Self

The IDs of the users.

pub fn set_user_ids(self, input: Option<String>) -> Self

The IDs of the users.

pub fn query(self, input: impl Into<String>) -> Self

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

pub fn set_query(self, input: Option<String>) -> Self

A query to filter users by user name. Remember the following about the Userids and Query parameters:

• If you don't use either parameter, the API returns a paginated list of all users on the site.

• If you use both parameters, the API ignores the Query parameter.

• The Userid parameter only returns user names that match a corresponding user ID.

• The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

pub fn include(self, input: UserFilterType) -> Self

The state of the users. Specify "ALL" to include inactive users.

pub fn set_include(self, input: Option<UserFilterType>) -> Self

The state of the users. Specify "ALL" to include inactive users.

pub fn order(self, input: OrderType) -> Self

The order for the results.

pub fn set_order(self, input: Option<OrderType>) -> Self

The order for the results.

pub fn sort(self, input: UserSortType) -> Self

The sorting criteria.

pub fn set_sort(self, input: Option<UserSortType>) -> Self

The sorting criteria.

pub fn marker(self, input: impl Into<String>) -> Self

The marker for the next set of results. (You received this marker from a previous call.)

pub fn set_marker(self, input: Option<String>) -> Self

The marker for the next set of results. (You received this marker from a previous call.)

pub fn limit(self, input: i32) -> Self

The maximum number of items to return.

pub fn set_limit(self, input: Option<i32>) -> Self

The maximum number of items to return.

pub fn fields(self, input: impl Into<String>) -> Self

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

pub fn set_fields(self, input: Option<String>) -> Self

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

pub fn build(self) -> Result<DescribeUsersInput, BuildError>

Consumes the builder and constructs a DescribeUsersInput.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder