Struct SearchResourcesInput

#[non_exhaustive]
pub struct SearchResourcesInput {
    pub authentication_token: Option<String>,
    pub query_text: Option<String>,
    pub query_scopes: Option<Vec<SearchQueryScopeType>>,
    pub organization_id: Option<String>,
    pub additional_response_fields: Option<Vec<AdditionalResponseFieldType>>,
    pub filters: Option<Filters>,
    pub order_by: Option<Vec<SearchSortResult>>,
    pub limit: Option<i32>,
    pub marker: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

authentication_token: Option<String>

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

query_text: 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.

query_scopes: 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

organization_id: Option<String>

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

additional_response_fields: 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.

filters: Option<Filters>

Filters results based on entity metadata.

order_by: Option<Vec<SearchSortResult>>

Order by results in one or more categories.

limit: Option<i32>

Max results count per page.

marker: Option<String>

The marker for the next set of results.

Implementations

impl SearchResourcesInput

pub fn authentication_token(&self) -> Option<&str>

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

pub fn query_text(&self) -> Option<&str>

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) -> &[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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .query_scopes.is_none().

pub fn organization_id(&self) -> Option<&str>

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

pub fn additional_response_fields(&self) -> &[AdditionalResponseFieldType]

A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_response_fields.is_none().

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

Filters results based on entity metadata.

pub fn order_by(&self) -> &[SearchSortResult]

Order by results in one or more categories.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .order_by.is_none().

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

Max results count per page.

pub fn marker(&self) -> Option<&str>

The marker for the next set of results.

impl SearchResourcesInput

pub fn builder() -> SearchResourcesInputBuilder

Creates a new builder-style object to manufacture SearchResourcesInput.

Trait Implementations

impl Clone for SearchResourcesInput

fn clone(&self) -> SearchResourcesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchResourcesInput

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

Formats the value using the given formatter.

impl PartialEq for SearchResourcesInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SearchResourcesInput