Struct google_api_proto::google::spanner::admin::database::v1::ListBackupOperationsRequest

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

The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

Fields

parent: String

Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

filter: String

An expression that filters the list of returned backup operations.

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 [operation][google.longrunning.Operation] are eligible for filtering:

• name - The name of the long-running operation
• done - False if the operation is in progress, else true.
• metadata.@type - the type of metadata. For example, the type string for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata.
• metadata.<field_name> - any field in metadata.value. metadata.@type must be specified first if filtering on metadata fields.
• error - Error associated with the long-running operation.
• response.@type - the type of response.
• response.<field_name> - any field in response.value.

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:

• done:true - The operation is complete.
• (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND
metadata.database:prod - Returns operations where:
  • The operation’s metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
  • The source database name of backup contains the string “prod”.
• (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND
(metadata.name:howl) AND
(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND
(error:*) - Returns operations where:
  • The operation’s metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
  • The backup name contains the string “howl”.
  • The operation started before 2018-03-28T14:50:00Z.
  • The operation resulted in an error.
• (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
(metadata.source_backup:test) AND
(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND
(error:*) - Returns operations where:
  • The operation’s metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
  • The source backup name contains the string “test”.
  • The operation started before 2022-01-18T14:50:00Z.
  • The operation resulted in an error.
• ((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND
(metadata.database:test_db)) OR
((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
(metadata.source_backup:test_bkp)) AND
(error:*) - Returns operations where:
  • The operation’s metadata matches either of criteria:
    • The operation’s metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the source database name of the backup contains the string “test_db”
    • The operation’s metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the source backup name contains the string “test_bkp”
  • The operation resulted in an error.

page_size: i32

Number of operations 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.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the same parent and with the same filter.

Trait Implementations

impl Clone for ListBackupOperationsRequest

fn clone(&self) -> ListBackupOperationsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListBackupOperationsRequest

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

Formats the value using the given formatter.

impl Default for ListBackupOperationsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ListBackupOperationsRequest

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 ListBackupOperationsRequest

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