Struct gcp_client::google::bigtable::admin::v2::ListBackupsRequest

pub struct ListBackupsRequest {
    pub parent: String,
    pub filter: String,
    pub order_by: String,
    pub page_size: i32,
    pub page_token: String,
}

The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

Fields

parent: String

Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

filter: String

A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive.

The fields eligible for filtering are:

• name
• source_table
• state
• start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
• end_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)
• size_bytes

To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:

• name:"exact" --> The backup's name is the string "exact".
• name:howl --> The backup's name contains the string "howl".
• source_table:prod --> The source_table'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 (start_time < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.
• size_bytes > 10000000000 --> The backup's size is greater than 10GB

order_by: String

An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in [Backup][google.bigtable.admin.v2.Backup]. The full syntax is described at https://aip.dev/132#ordering.

Fields supported are:

• name
• source_table
• expire_time
• start_time
• end_time
• size_bytes
• state

For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant.

If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

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][google.bigtable.admin.v2.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the same parent and with the same filter.

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

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<ListBackupsRequest> for ListBackupsRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ListBackupsRequest