Struct aws_sdk_workdocs::operation::search_resources::builders::SearchResourcesFluentBuilder

pub struct SearchResourcesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SearchResources.

Searches metadata and the content of folders, documents, document versions, and comments.

Implementations

impl SearchResourcesFluentBuilder

pub fn as_input(&self) -> &SearchResourcesInputBuilder

Access the SearchResources as a reference.

pub async fn send( self ) -> Result<SearchResourcesOutput, SdkError<SearchResourcesError, 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.

pub fn customize( self ) -> CustomizableOperation<SearchResourcesOutput, SearchResourcesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> SearchResourcesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

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.

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.

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.

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.

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.

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.

pub fn query_scopes(self, input: SearchQueryScopeType) -> Self

Appends an item to QueryScopes.

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

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

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

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.

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.

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.

pub fn additional_response_fields( self, input: AdditionalResponseFieldType ) -> Self

Appends an item to AdditionalResponseFields.

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.

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.

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.

pub fn filters(self, input: Filters) -> Self

Filters results based on entity metadata.

pub fn set_filters(self, input: Option<Filters>) -> Self

Filters results based on entity metadata.

pub fn get_filters(&self) -> &Option<Filters>

Filters results based on entity metadata.

pub fn order_by(self, input: SearchSortResult) -> Self

Appends an item to OrderBy.

To override the contents of this collection use set_order_by.

Order by results in one or more categories.

pub fn set_order_by(self, input: Option<Vec<SearchSortResult>>) -> Self

Order by results in one or more categories.

pub fn get_order_by(&self) -> &Option<Vec<SearchSortResult>>

Order by results in one or more categories.

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

Max results count per page.

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

Max results count per page.

pub fn get_limit(&self) -> &Option<i32>

Max results count per page.

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

The marker for the next set of results.

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

The marker for the next set of results.

pub fn get_marker(&self) -> &Option<String>

The marker for the next set of results.

Trait Implementations

impl Clone for SearchResourcesFluentBuilder

fn clone(&self) -> SearchResourcesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResourcesFluentBuilder

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

Formats the value using the given formatter.