Struct google_cloud_storage::http::objects::list::ListObjectsRequest

pub struct ListObjectsRequest {
    pub bucket: String,
    pub delimiter: Option<String>,
    pub end_offset: Option<String>,
    pub include_trailing_delimiter: Option<bool>,
    pub max_results: Option<i32>,
    pub page_token: Option<String>,
    pub prefix: Option<String>,
    pub projection: Option<Projection>,
    pub start_offset: Option<String>,
    pub versions: Option<bool>,
}

Request message for GetNotification.

Fields

bucket: String

Name of the bucket in which to look for objects.

delimiter: Option<String>

Returns results in a directory-like mode, with / being a common value for the delimiter. items[] contains object metadata for objects whose names do not contain delimiter, or whose names only have instances of delimiter in their prefix. prefixes[] contains truncated object names for objects whose names contain delimiter after any prefix. Object names are truncated beyond the first applicable instance of the delimiter. If multiple objects have the same truncated name, duplicates are omitted.

end_offset: Option<String>

Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed have names between startOffset (inclusive) and endOffset (exclusive).

include_trailing_delimiter: Option<bool>

If true, objects that end in exactly one instance of delimiter have their metadata included in items[] in addition to the relevant part of the object name appearing in prefixes[].

max_results: Option<i32>

Maximum combined number of entries in items[] and prefixes[] to return in a single page of responses. The service may return fewer results than maxResults so the presence of nextPageToken should always be checked. The recommended upper value for maxResults is 1000 objects in a single response.

page_token: Option<String>

A previously-returned page token representing part of the larger set of results to view. The pageToken is an encoded field that marks the name and generation of the last object in the returned list. In a subsequent request using the pageToken, items that come after the pageToken are shown (up to maxResults). If you start a listing and then create an object in the bucket before using a pageToken to continue listing, you do not see the new object in subsequent listing results if it is in part of the object namespace already listed.

prefix: Option<String>

Filter results to include only objects whose names begin with this prefix.

projection: Option<Projection>

Set of properties to return. Defaults to noAcl. Acceptable values are: full: Include all properties. noAcl: Omit the owner, acl property.

start_offset: Option<String>

Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed have names between startOffset (inclusive) and endOffset (exclusive).

versions: Option<bool>

If true, lists all versions of an object as distinct results in order of increasing generation number. The default value for versions is false. For more information, see Object Versioning.

Trait Implementations

impl Clone for ListObjectsRequest

fn clone(&self) -> ListObjectsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListObjectsRequest

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

Formats the value using the given formatter.

impl Default for ListObjectsRequest

fn default() -> ListObjectsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListObjectsRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ListObjectsRequest

fn eq(&self, other: &ListObjectsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ListObjectsRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ListObjectsRequest

impl StructuralPartialEq for ListObjectsRequest