Struct aws_sdk_connectcases::client::fluent_builders::SearchCases

pub struct SearchCases { /* private fields */ }

Fluent builder constructing a request to SearchCases.

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

Implementations

impl SearchCases

pub async fn customize(
    self
) -> Result<CustomizableOperation<SearchCases, AwsResponseRetryClassifier>, SdkError<SearchCasesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(self) -> Result<SearchCasesOutput, SdkError<SearchCasesError>>

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 into_paginator(self) -> SearchCasesPaginator

Create a paginator for this request

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

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

The unique identifier of the Cases domain.

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

The unique identifier of the Cases domain.

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

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

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

The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

A word or phrase used to perform a quick search.

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

A word or phrase used to perform a quick search.

pub fn filter(self, input: CaseFilter) -> Self

A list of filter objects.

pub fn set_filter(self, input: Option<CaseFilter>) -> Self

A list of filter objects.

pub fn sorts(self, input: Sort) -> Self

Appends an item to sorts.

To override the contents of this collection use set_sorts.

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

pub fn set_sorts(self, input: Option<Vec<Sort>>) -> Self

A list of sorts where each sort specifies a field and their sort order to be applied to the results.

pub fn fields(self, input: FieldIdentifier) -> Self

Appends an item to fields.

To override the contents of this collection use set_fields.

The list of field identifiers to be returned as part of the response.

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

The list of field identifiers to be returned as part of the response.

Trait Implementations

impl Clone for SearchCases

fn clone(&self) -> SearchCases

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchCases

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

Formats the value using the given formatter.