Struct google_api_proto::google::storage::v1::WatchAllObjectsRequest

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

Request message for WatchAllObjects.

Fields

bucket: String

Name of the bucket in which to look for objects.

versions: bool

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

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.

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.

prefix: String

Filter results to objects whose names begin with this prefix.

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.

page_token: String

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

projection: i32

Set of properties to return. Defaults to NO_ACL.

channel: Option<Channel>

Properties of the channel to be inserted.

common_request_params: Option<CommonRequestParams>

A set of parameters common to all Storage API requests.

Implementations

impl WatchAllObjectsRequest

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 WatchAllObjectsRequest

fn clone(&self) -> WatchAllObjectsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WatchAllObjectsRequest

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

Formats the value using the given formatter.

impl Default for WatchAllObjectsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for WatchAllObjectsRequest

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 WatchAllObjectsRequest

fn eq(&self, other: &WatchAllObjectsRequest) -> 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 WatchAllObjectsRequest