Struct google_api_proto::google::storage::v2::ListObjectsRequest

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,
}

Request message for ListObjects.

Fields

parent: String

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

page_size: i32

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

page_token: String

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

delimiter: String

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

include_trailing_delimiter: bool

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

prefix: String

Filter results to objects whose names begin with this prefix.

versions: bool

If true, lists all versions of an object as distinct results. For more information, see Object Versioning.

read_mask: Option<FieldMask>

Mask specifying which fields to read from each result. If no mask is specified, will default to all fields except items.acl and items.owner.

• may 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, will also include 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.

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() -> Self

Returns the “default value” for a type.

impl Message for ListObjectsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

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 StructuralPartialEq for ListObjectsRequest