Struct ListBackupsRequest

#[non_exhaustive]
pub struct ListBackupsRequest {
    pub parent: String,
    pub filter: String,
    pub page_size: i32,
    pub page_token: String,
}

The request for ListBackups.

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. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

filter: String

An expression that filters the list of returned backups.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive.

The following fields in the Backup are eligible for filtering:

• name
• database
• state
• create_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
• expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
• version_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
• size_bytes
• backup_schedules

You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly.

Here are a few examples:

• name:Howl - The backup’s name contains the string “howl”.
• database:prod
  • The database’s name contains the string “prod”.
• state:CREATING - The backup is pending creation.
• state:READY - The backup is fully created and ready for use.
• (name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")
  • The backup name contains the string “howl” and create_time of the backup is before 2018-03-28T14:50:00Z.
• expire_time < \"2018-03-28T14:50:00Z\"
  • The backup expire_time is before 2018-03-28T14:50:00Z.
• size_bytes > 10000000000 - The backup’s size is greater than 10GB
• backup_schedules:daily
  • The backup is created from a schedule with “daily” in its name.

page_size: i32

Number of backups to be returned in the response. If 0 or less, defaults to the server’s maximum allowed page size.

page_token: String

If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.

Implementations

impl ListBackupsRequest

pub fn new() -> Self

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

Sets the value of parent.

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

Sets the value of filter.

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

Sets the value of page_size.

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

Sets the value of page_token.

Trait Implementations

impl Clone for ListBackupsRequest

fn clone(&self) -> ListBackupsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListBackupsRequest

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

Formats the value using the given formatter.

impl Default for ListBackupsRequest

fn default() -> ListBackupsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListBackupsRequest

where ListBackupsRequest: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ListBackupsRequest

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for ListBackupsRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ListBackupsRequest