Struct openstack_sdk::api::object_store::v1::container::get::ContainerBuilder

pub struct ContainerBuilder<'a> { /* private fields */ }

Builder for Container.

Implementations

impl<'a> ContainerBuilder<'a>

pub fn container<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE ) -> &mut Self

The unique (within an account) name for the container. The container name must be from 1 to 256 characters long and can start with any character and contain any pattern. Character set must be UTF-8. The container name cannot contain a slash (/) character because this character delimits the container and object name. For example, the path /v1/account/www/pages specifies the www container, not the www/pages container.

pub fn limit(&mut self, value: u32) -> &mut Self

For an integer value n, limits the number of results to n.

pub fn marker<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

For a string value, x, constrains the list to items whose names are greater than x.

pub fn end_marker<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE ) -> &mut Self

For a string value, x, constrains the list to items whose names are less than x.

pub fn format<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

The response format. Valid values are json, xml, or plain. The default is plain. If you append the format=xml or format=json query parameter to the storage account URL, the response shows extended container information serialized in that format. If you append the format=plain query parameter, the response lists the container names separated by newlines.

pub fn prefix<VALUE: Into<Cow<'a, str>>>(&mut self, value: VALUE) -> &mut Self

Only objects with this prefix will be returned. When combined with a delimiter query, this enables API users to simulate and traverse the objects in a container as if they were in a directory tree.

pub fn delimiter<VALUE: Into<Cow<'a, str>>>( &mut self, value: VALUE ) -> &mut Self

The delimiter is a single character used to split object names to present a pseudo-directory hierarchy of objects. When combined with a prefix query, this enables API users to simulate and traverse the objects in a container as if they were in a directory tree.

pub fn reverse(&mut self, value: bool) -> &mut Self

By default, listings are returned sorted by name, ascending. If you include the reverse=true query parameter, the listing will be returned sorted by name, descending.

pub fn build(&self) -> Result<Container<'a>, ContainerBuilderError>

Builds a new Container.

Errors

If a required field has not been initialized.

impl<'a> ContainerBuilder<'a>

pub fn header( &mut self, header_name: &'static str, header_value: &'static str ) -> &mut Self

Add a single header to the Container.

pub fn headers<I, T>(&mut self, iter: I) -> &mut Self

where I: Iterator<Item = T>, T: Into<(Option<HeaderName>, HeaderValue)>,

Add multiple headers.

Trait Implementations

impl<'a> Clone for ContainerBuilder<'a>

fn clone(&self) -> ContainerBuilder<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Default for ContainerBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.