pub struct ListLocationsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListLocations
.
Returns a list of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
Implementations§
source§impl ListLocationsFluentBuilder
impl ListLocationsFluentBuilder
sourcepub fn as_input(&self) -> &ListLocationsInputBuilder
pub fn as_input(&self) -> &ListLocationsInputBuilder
Access the ListLocations as a reference.
sourcepub async fn send(
self
) -> Result<ListLocationsOutput, SdkError<ListLocationsError, HttpResponse>>
pub async fn send( self ) -> Result<ListLocationsOutput, SdkError<ListLocationsError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<ListLocationsOutput, ListLocationsError, Self>
pub fn customize( self ) -> CustomizableOperation<ListLocationsOutput, ListLocationsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListLocationsPaginator
pub fn into_paginator(self) -> ListLocationsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of locations to return.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of locations to return.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of locations to return.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
An opaque string that indicates the position at which to begin the next list of locations.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
An opaque string that indicates the position at which to begin the next list of locations.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
An opaque string that indicates the position at which to begin the next list of locations.
sourcepub fn filters(self, input: LocationFilter) -> Self
pub fn filters(self, input: LocationFilter) -> Self
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
You can use API filters to narrow down the list of resources returned by ListLocations
. For example, to retrieve all tasks on a specific source location, you can use ListLocations
with filter name LocationType S3
and Operator Equals
.
sourcepub fn set_filters(self, input: Option<Vec<LocationFilter>>) -> Self
pub fn set_filters(self, input: Option<Vec<LocationFilter>>) -> Self
You can use API filters to narrow down the list of resources returned by ListLocations
. For example, to retrieve all tasks on a specific source location, you can use ListLocations
with filter name LocationType S3
and Operator Equals
.
sourcepub fn get_filters(&self) -> &Option<Vec<LocationFilter>>
pub fn get_filters(&self) -> &Option<Vec<LocationFilter>>
You can use API filters to narrow down the list of resources returned by ListLocations
. For example, to retrieve all tasks on a specific source location, you can use ListLocations
with filter name LocationType S3
and Operator Equals
.
Trait Implementations§
source§impl Clone for ListLocationsFluentBuilder
impl Clone for ListLocationsFluentBuilder
source§fn clone(&self) -> ListLocationsFluentBuilder
fn clone(&self) -> ListLocationsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more