Struct gcp_client::google::storage::v1::ListObjectsRequest

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

Request message for ListObjects.

Fields

bucket: String

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

delimiter: String

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.

max_results: 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.

prefix: String

Filter results to objects whose names begin with this prefix.

projection: i32

Set of properties to return. Defaults to NO_ACL.

versions: bool

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

common_request_params: Option<CommonRequestParams>

A set of parameters common to all Storage API requests.

Implementations

impl ListObjectsRequest

pub fn projection(&self) -> Projection

Returns the enum value of projection, or the default if the field is set to an invalid enum value.

pub fn set_projection(&mut self, value: Projection)

Sets projection to the provided enum value.

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

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

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

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

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

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

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

impl PartialEq<ListObjectsRequest> 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: &ListObjectsRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for ListObjectsRequest