Struct aws_sdk_fsx::operation::describe_file_caches::builders::DescribeFileCachesFluentBuilder

pub struct DescribeFileCachesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DescribeFileCaches.

Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

• The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value.

• The order of caches returned in the response of one DescribeFileCaches call and the order of caches returned across the responses of a multicall iteration is unspecified.

Implementations

impl DescribeFileCachesFluentBuilder

pub fn as_input(&self) -> &DescribeFileCachesInputBuilder

Access the DescribeFileCaches as a reference.

pub async fn send( self ) -> Result<DescribeFileCachesOutput, SdkError<DescribeFileCachesError, 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<DescribeFileCachesOutput, DescribeFileCachesError, Self>

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

pub fn into_paginator(self) -> DescribeFileCachesPaginator

Create a paginator for this request

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

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

Appends an item to FileCacheIds.

To override the contents of this collection use set_file_cache_ids.

IDs of the caches whose descriptions you want to retrieve (String).

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

IDs of the caches whose descriptions you want to retrieve (String).

pub fn get_file_cache_ids(&self) -> &Option<Vec<String>>

IDs of the caches whose descriptions you want to retrieve (String).

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

The maximum number of resources to return in the response. This value must be an integer greater than zero.

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

The maximum number of resources to return in the response. This value must be an integer greater than zero.

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

The maximum number of resources to return in the response. This value must be an integer greater than zero.

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

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

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

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

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

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Trait Implementations

impl Clone for DescribeFileCachesFluentBuilder

fn clone(&self) -> DescribeFileCachesFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeFileCachesFluentBuilder

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

Formats the value using the given formatter.