pub struct RequestBuilder { /* private fields */ }
Expand description
RequestBuilder
provides a mechanism for setting optional parameters on a request.
Each RequestBuilder
parameter method call returns Self
, so setting of multiple
parameters can be chained.
To finalize and submit the request, invoke .await
, which
which will convert the RequestBuilder
into a future
executes the request and returns a Result
with the parsed
response.
In order to execute the request without polling the service
until the operation completes, use .send().await
instead.
If you need lower-level access to the raw response details
(e.g. to inspect response headers or raw body data) then you
can finalize the request using the
[RequestBuilder::send()
] method which returns a future
that resolves to a lower-level Response
value.
Implementations§
source§impl RequestBuilder
impl RequestBuilder
sourcepub fn snapshot(self, snapshot: impl Into<String>) -> Self
pub fn snapshot(self, snapshot: impl Into<String>) -> Self
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see Creating a Snapshot of a Blob.
sourcepub fn timeout(self, timeout: i64) -> Self
pub fn timeout(self, timeout: i64) -> Self
The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
sourcepub fn x_ms_range(self, x_ms_range: impl Into<String>) -> Self
pub fn x_ms_range(self, x_ms_range: impl Into<String>) -> Self
Return only the bytes of the blob in the specified range.
sourcepub fn x_ms_lease_id(self, x_ms_lease_id: impl Into<String>) -> Self
pub fn x_ms_lease_id(self, x_ms_lease_id: impl Into<String>) -> Self
If specified, the operation only succeeds if the resource’s lease is active and matches this ID.
sourcepub fn if_modified_since(
self,
if_modified_since: impl Into<OffsetDateTime>,
) -> Self
pub fn if_modified_since( self, if_modified_since: impl Into<OffsetDateTime>, ) -> Self
Specify this header value to operate only on a blob if it has been modified since the specified date/time.
sourcepub fn if_unmodified_since(
self,
if_unmodified_since: impl Into<OffsetDateTime>,
) -> Self
pub fn if_unmodified_since( self, if_unmodified_since: impl Into<OffsetDateTime>, ) -> Self
Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
sourcepub fn if_match(self, if_match: impl Into<String>) -> Self
pub fn if_match(self, if_match: impl Into<String>) -> Self
Specify an ETag value to operate only on blobs with a matching value.
sourcepub fn if_none_match(self, if_none_match: impl Into<String>) -> Self
pub fn if_none_match(self, if_none_match: impl Into<String>) -> Self
Specify an ETag value to operate only on blobs without a matching value.
Specify a SQL where clause on blob tags to operate only on blobs with a matching value.
sourcepub fn x_ms_client_request_id(
self,
x_ms_client_request_id: impl Into<String>,
) -> Self
pub fn x_ms_client_request_id( self, x_ms_client_request_id: impl Into<String>, ) -> Self
Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.
sourcepub fn marker(self, marker: impl Into<String>) -> Self
pub fn marker(self, marker: impl Into<String>) -> Self
A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the NextMarker value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client.
sourcepub fn maxresults(self, maxresults: i64) -> Self
pub fn maxresults(self, maxresults: i64) -> Self
Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000.
pub fn into_stream(self) -> Pageable<PageList, Error>
Trait Implementations§
source§impl Clone for RequestBuilder
impl Clone for RequestBuilder
source§fn clone(&self) -> RequestBuilder
fn clone(&self) -> RequestBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for RequestBuilder
impl !RefUnwindSafe for RequestBuilder
impl Send for RequestBuilder
impl Sync for RequestBuilder
impl Unpin for RequestBuilder
impl !UnwindSafe for RequestBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)