Struct ListObjectsRequest 

#[non_exhaustive]
pub struct ListObjectsRequest {

    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub delimiter: String,
    pub include_trailing_delimiter: bool,
    pub prefix: String,
    pub versions: bool,
    pub read_mask: Option<FieldMask>,
    pub lexicographic_start: String,
    pub lexicographic_end: String,
    pub soft_deleted: bool,
    pub include_folders_as_prefixes: bool,
    pub match_glob: String,
    pub filter: String,
    /* private fields */
}

Request message for ListObjects.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

Required. Name of the bucket in which to look for objects.

page_size: i32

Optional. Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results might be returned than requested. The service uses this parameter or 1,000 items, whichever is smaller.

page_token: String

Optional. A previously-returned page token representing part of the larger set of results to view.

delimiter: String

Optional. If set, returns results in a directory-like mode. items contains only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter has their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

include_trailing_delimiter: bool

Optional. If true, objects that end in exactly one instance of delimiter has their metadata included in items in addition to prefixes.

prefix: String

Optional. Filter results to objects whose names begin with this prefix.

versions: bool

Optional. If true, lists all versions of an object as distinct results.

read_mask: Option<FieldMask>

Mask specifying which fields to read from each result. If no mask is specified, defaults to all fields except items.acl and items.owner. * might be used to mean all fields.

lexicographic_start: String

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

lexicographic_end: String

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

soft_deleted: bool

Optional. If true, only list all soft-deleted versions of the object. Soft delete policy is required to set this option.

include_folders_as_prefixes: bool

Optional. If true, includes folders and managed folders (besides objects) in the returned prefixes. Requires delimiter to be set to ‘/’.

match_glob: String

Optional. Filter results to objects and prefixes that match this glob pattern. See List objects using glob for the full syntax.

filter: String

Optional. An expression used to filter the returned objects by the context field. For the full syntax, see Filter objects by contexts syntax. If a delimiter is set, the returned prefixes are exempt from this filter.

Implementations

impl ListObjectsRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListObjectsRequest::new().set_parent("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListObjectsRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListObjectsRequest::new().set_page_token("example");

pub fn set_delimiter<T: Into<String>>(self, v: T) -> Self

Sets the value of delimiter.

Example

let x = ListObjectsRequest::new().set_delimiter("example");

pub fn set_include_trailing_delimiter<T: Into<bool>>(self, v: T) -> Self

Sets the value of include_trailing_delimiter.

Example

let x = ListObjectsRequest::new().set_include_trailing_delimiter(true);

pub fn set_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of prefix.

Example

let x = ListObjectsRequest::new().set_prefix("example");

pub fn set_versions<T: Into<bool>>(self, v: T) -> Self

Sets the value of versions.

Example

let x = ListObjectsRequest::new().set_versions(true);

pub fn set_read_mask<T>(self, v: T) -> Self

where T: Into<FieldMask>,

Sets the value of read_mask.

Example

use wkt::FieldMask;
let x = ListObjectsRequest::new().set_read_mask(FieldMask::default()/* use setters */);

pub fn set_or_clear_read_mask<T>(self, v: Option<T>) -> Self

where T: Into<FieldMask>,

Sets or clears the value of read_mask.

Example

use wkt::FieldMask;
let x = ListObjectsRequest::new().set_or_clear_read_mask(Some(FieldMask::default()/* use setters */));
let x = ListObjectsRequest::new().set_or_clear_read_mask(None::<FieldMask>);

pub fn set_lexicographic_start<T: Into<String>>(self, v: T) -> Self

Sets the value of lexicographic_start.

Example

let x = ListObjectsRequest::new().set_lexicographic_start("example");

pub fn set_lexicographic_end<T: Into<String>>(self, v: T) -> Self

Sets the value of lexicographic_end.

Example

let x = ListObjectsRequest::new().set_lexicographic_end("example");

pub fn set_soft_deleted<T: Into<bool>>(self, v: T) -> Self

Sets the value of soft_deleted.

Example

let x = ListObjectsRequest::new().set_soft_deleted(true);

pub fn set_include_folders_as_prefixes<T: Into<bool>>(self, v: T) -> Self

Sets the value of include_folders_as_prefixes.

Example

let x = ListObjectsRequest::new().set_include_folders_as_prefixes(true);

pub fn set_match_glob<T: Into<String>>(self, v: T) -> Self

Sets the value of match_glob.

Example

let x = ListObjectsRequest::new().set_match_glob("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListObjectsRequest::new().set_filter("example");

Trait Implementations

impl Clone for ListObjectsRequest

fn clone(&self) -> ListObjectsRequest

Returns a duplicate 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 Message for ListObjectsRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListObjectsRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListObjectsRequest